dev-containers.md

 1# Dev Containers
 2
 3Dev Containers provide a consistent, reproducible development environment by defining your project's dependencies, tools, and settings in a container configuration.
 4
 5If your repository includes a `.devcontainer/devcontainer.json` file, Zed can open a project inside a development container.
 6
 7## Requirements
 8
 9- Docker must be installed and available in your `PATH`. Zed requires the `docker` command to be present. If you use Podman, you can alias it to `docker` (e.g., `alias docker=podman`).
10- Your project must contain a `.devcontainer/devcontainer.json` directory/file.
11
12## Using Dev Containers in Zed
13
14### Automatic prompt
15
16When you open a project that contains the `.devcontainer/devcontainer.json` directory/file, Zed will display a prompt asking whether to open the project inside the dev container. Choosing "Open in Container" will:
17
181. Build the dev container image (if needed).
192. Launch the container.
203. Reopen the project connected to the container environment.
21
22### Manual open
23
24If you dismiss the prompt or want to reopen the project inside a container later, you can use Zed's command palette to run the "Project: Open Remote" command and select the option to open the project in a dev container.
25Alternatively, you can reach for the Remote Projects modal (through the {#kb projects::OpenRemote} binding) and choose the "Connect Dev Container" option.
26
27## Editing the dev container configuration
28
29If you modify `.devcontainer/devcontainer.json`, Zed does not currently rebuild or reload the container automatically. After changing configuration:
30
31- Stop or kill the existing container manually (e.g., via `docker kill <container>`).
32- Reopen the project in the container.
33
34## Working in a Dev Container
35
36Once connected, Zed operates inside the container environment for tasks, terminals, and language servers.
37Files are linked from your workspace into the container according to the dev container specification.
38
39## Known Limitations
40
41> **Note:** This feature is still in development.
42
43- **Extensions:** Zed does not yet manage extensions separately for container environments. The host's extensions are used as-is.
44- **Port forwarding:** Only the `appPort` field is supported. `forwardPorts` and other advanced port-forwarding features are not implemented.
45- **Configuration changes:** Updates to `devcontainer.json` do not trigger automatic rebuilds or reloads; containers must be manually restarted.
46
47## See also
48
49- [Remote Development](./remote-development.md) for connecting to remote servers over SSH.
50- [Tasks](./tasks.md) for running commands in the integrated terminal.