Skip to content

Commit 0358628

Browse files
committed
Start README
1 parent dc0bdf3 commit 0358628

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# devcontainer-cli
2+
3+
devcontainer-cli is the start of a CLI to improve the experience of working with [Visual Studio Code devcontainers](https://code.visualstudio.com/docs/remote/containers)
4+
5+
## Installation
6+
7+
TODO - add this once releases are automated!
8+
9+
## Enabling bash completion
10+
11+
To enable bash completion, add the following to you `~/.bashrc` file:
12+
13+
```bash
14+
. <(devcontainer completion)
15+
```
16+
17+
## Usage
18+
19+
### Listing devcontainers
20+
21+
To see which running devcontainers the CLI detects you can run the `list` command.
22+
23+
### Running commands inside a devcontainer
24+
25+
`devcontainer` allows you to run commands in devcontainers. This is similar to `docker exec` but works with devcontainer names (rather than requiring container names/IDs).
26+
27+
For example:
28+
29+
```bash
30+
# Run an interactive bash shell in the vscode-remote-test-dockerfile devcontainer
31+
devcontainer exec vscode-remote-test-dockerfile bash
32+
33+
# Run a command with args in the vscode-remote-test-dockercompose_devcontainer/mongo devcontainer
34+
devcontainer exec vscode-remote-test-dockercompose_devcontainer/mongo ls -a /workspaces/vscode-remote-test-dockerfile
35+
```

0 commit comments

Comments
 (0)