• Get started
  • Guides
  • Manuals
  • Reference
K
Start typing to search… or try
Reference
  • Get started
  • Guides
  • Manuals
This section
    • docker
      • docker build (legacy builder)
      • docker builder
        • docker builder prune
      • docker buildx
        • docker buildx bake
        • docker buildx build
        • docker buildx create
        • docker buildx debug
          • docker buildx debug build
        • docker buildx du
        • docker buildx imagetools
          • docker buildx imagetools create
          • docker buildx imagetools inspect
        • docker buildx inspect
        • docker buildx ls
        • docker buildx prune
        • docker buildx rm
        • docker buildx stop
        • docker buildx use
        • docker buildx version
      • docker checkpoint
        • docker checkpoint create
        • docker checkpoint ls
        • docker checkpoint rm
      • docker compose
        • docker compose alpha
          • docker compose alpha dry-run
          • docker compose alpha publish
          • docker compose alpha scale
          • docker compose alpha viz
        • docker compose build
        • docker compose config
        • docker compose cp
        • docker compose create
        • docker compose down
        • docker compose events
        • docker compose exec
        • docker compose images
        • docker compose kill
        • docker compose logs
        • docker compose ls
        • docker compose pause
        • docker compose port
        • docker compose ps
        • docker compose pull
        • docker compose push
        • docker compose restart
        • docker compose rm
        • docker compose run
        • docker compose start
        • docker compose stop
        • docker compose top
        • docker compose unpause
        • docker compose up
        • docker compose version
        • docker compose wait
        • docker compose watch
      • docker config
        • docker config create
        • docker config inspect
        • docker config ls
        • docker config rm
      • docker container
        • docker container attach
        • docker container commit
        • docker container cp
        • docker container create
        • docker container diff
        • docker container export
        • docker container inspect
        • docker container kill
        • docker container logs
        • docker container pause
        • docker container port
        • docker container prune
        • docker container rename
        • docker container restart
        • docker container rm
        • docker container start
        • docker container stats
        • docker container stop
        • docker container top
        • docker container unpause
        • docker container update
        • docker container wait
        • docker exec
        • docker ps
        • docker run
      • docker context
        • docker context create
        • docker context export
        • docker context import
        • docker context inspect
        • docker context ls
        • docker context rm
        • docker context show
        • docker context update
        • docker context use
      • docker debug
      • docker image
        • docker image history
        • docker image import
        • docker image inspect
        • docker image load
        • docker image prune
        • docker image rm
        • docker image save
        • docker image tag
        • docker images
        • docker pull
        • docker push
      • docker init
      • docker inspect
      • docker login
      • docker logout
      • docker manifest
        • docker manifest annotate
        • docker manifest create
        • docker manifest inspect
        • docker manifest push
        • docker manifest rm
      • docker network
        • docker network connect
        • docker network create
        • docker network disconnect
        • docker network inspect
        • docker network ls
        • docker network prune
        • docker network rm
      • docker node
        • docker node demote
        • docker node inspect
        • docker node ls
        • docker node promote
        • docker node ps
        • docker node rm
        • docker node update
      • docker plugin
        • docker plugin create
        • docker plugin disable
        • docker plugin enable
        • docker plugin inspect
        • docker plugin install
        • docker plugin ls
        • docker plugin push
        • docker plugin rm
        • docker plugin set
        • docker plugin upgrade
      • docker scout
        • docker scout attestation
          • docker scout attestation add
        • docker scout cache
          • docker scout cache df
          • docker scout cache prune
        • docker scout compare
        • docker scout config
        • docker scout cves
        • docker scout enroll
        • docker scout environment
        • docker scout integration
          • docker scout integration configure
          • docker scout integration delete
          • docker scout integration list
        • docker scout policy
        • docker scout push
        • docker scout quickview
        • docker scout recommendations
        • docker scout repo
          • docker scout repo disable
          • docker scout repo enable
          • docker scout repo list
        • docker scout sbom
        • docker scout stream
        • docker scout version
        • docker scout watch
      • docker search
      • docker secret
        • docker secret create
        • docker secret inspect
        • docker secret ls
        • docker secret rm
      • docker service
        • docker service create
        • docker service inspect
        • docker service logs
        • docker service ls
        • docker service ps
        • docker service rm
        • docker service rollback
        • docker service scale
        • docker service update
      • docker stack
        • docker stack config
        • docker stack deploy
        • docker stack ls
        • docker stack ps
        • docker stack rm
        • docker stack services
      • docker swarm
        • docker swarm ca
        • docker swarm init
        • docker swarm join
        • docker swarm join-token
        • docker swarm leave
        • docker swarm unlock
        • docker swarm unlock-key
        • docker swarm update
      • docker system
        • docker info
        • docker system df
        • docker system events
        • docker system prune
      • docker trust
        • docker trust inspect
        • docker trust key
          • docker trust key generate
          • docker trust key load
        • docker trust revoke
        • docker trust sign
        • docker trust signer
          • docker trust signer add
          • docker trust signer remove
      • docker version
      • docker volume
        • docker volume create
        • docker volume inspect
        • docker volume ls
        • docker volume prune
        • docker volume rm
        • docker volume update
    • dockerd
    • Docker Engine API
      • SDK
        • Examples
      • Latest
        • v1.47
        • v1.46
        • v1.45
        • v1.44
        • v1.43
        • v1.42
        • v1.41
        • v1.40
        • v1.39
        • v1.38
        • v1.37
        • v1.36
        • v1.35
        • v1.34
        • v1.33
        • v1.32
        • v1.31
        • v1.30
        • v1.29
        • v1.28
        • v1.27
        • v1.26
        • v1.25
        • Engine API v1.24
      • Engine API version history
      • Docker Hub API
      • Docker Hub API v1 (deprecated)
      • DVP Data API
    • Extensions API
      • Interface: BackendV0
      • Interface: DesktopUI
      • Interface: Dialog
      • Interface: Docker
      • Interface: DockerCommand
      • Interface: DockerDesktopClient
      • Interface: Exec
      • Interface: ExecOptions
      • Interface: ExecProcess
      • Interface: ExecResult
      • Interface: ExecResultV0
      • Interface: ExecStreamOptions
      • Interface: Extension
      • Interface: ExtensionCli
      • Interface: ExtensionHost
      • Interface: ExtensionVM
      • Interface: Host
      • Interface: HttpService
      • Interface: NavigationIntents
      • Interface: OpenDialogResult
      • Interface: RawExecResult
      • Interface: RequestConfig
      • Interface: RequestConfigV0
      • Interface: ServiceError
      • Interface: SpawnOptions
      • Interface: Toast
  • Build checks
    • ConsistentInstructionCasing
    • CopyIgnoredFile
    • DuplicateStageName
    • FromAsCasing
    • FromPlatformFlagConstDisallowed
    • InvalidDefaultArgInFrom
    • InvalidDefinitionDescription
    • JSONArgsRecommended
    • LegacyKeyValueFormat
    • MaintainerDeprecated
    • MultipleInstructionsDisallowed
    • NoEmptyContinuation
    • RedundantTargetPlatform
    • ReservedStageName
    • SecretsUsedInArgOrEnv
    • StageNameCasing
    • UndefinedArgInFrom
    • UndefinedVar
    • WorkdirRelativePath
  • Compose file reference
    • Version and name top-level elements
    • Services top-level elements
    • Networks top-level elements
    • Volumes top-level element
    • Configs top-level elements
    • Secrets top-level elements
    • Fragments
    • Extensions
    • Interpolation
    • Merge
    • Include
    • Profiles
    • Compose Build Specification
    • Compose Deploy Specification
    • Compose Develop Specification
    • Legacy versions
  • Dockerfile reference
  • Glossary
  • Samples
    • .NET samples
    • AI/ML samples
    • Angular samples
    • Cloudflared samples
    • Django samples
    • Elasticsearch / Logstash / Kibana samples
    • Express samples
    • FastAPI samples
    • Flask samples
    • Gitea samples
    • Go samples
    • Java samples
    • JavaScript samples
    • MariaDB samples
    • Minecraft samples
    • MongoDB samples
    • MS-SQL samples
    • MySQL samples
    • Nextcloud samples
    • NGINX samples
    • Node.js samples
    • PHP samples
    • Pi-hole samples
    • Plex samples
    • Portainer samples
    • PostgreSQL samples
    • Prometheus samples
    • Python samples
    • Rails samples
    • React samples
    • Redis samples
    • Ruby samples
    • Rust samples
    • Spark samples
    • Spring Boot samples
    • Traefik samples
    • TypeScript samples
    • Vue.js samples
    • WireGuard samples
    • WordPress samples
Home / Reference / API reference / Extensions API / Interface: SpawnOptions

Interface: SpawnOptions

Table of contents
  • Hierarchy
  • Properties
    • cwd
      • env
        • stream

      Since

      0.3.0

      Hierarchy

      • ExecOptions

        ↳ SpawnOptions

      Properties

      cwd

      • Optional cwd: string

      Inherited from

      ExecOptions. cwd

      env

      • Optional env: ProcessEnv

      Inherited from

      ExecOptions. env

      stream

      • stream: ExecStreamOptions

      Edit this page

      Request changes

      Table of contents
      • Hierarchy
      • Properties
        • cwd
          • env
            • stream
          Product offerings Pricing About us Support Contribute

          Copyright © 2013-2024 Docker Inc. All rights reserved.

          Terms of Service Status Legal
          Theme: