Skip to content

Commit 9e31590

Browse files
committed
Update docs
1 parent 1ae2409 commit 9e31590

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,13 @@ devcontainer-cli is the start of a CLI to improve the experience of working with
44

55
**Status: this is a pet project that I've been experimenting with. It is not supported and you should expect bugs :-)**
66

7+
**NOTE: To avoid conflicts with the [official CLI](https://github.com/devcontainers/cli) the binary for this project has been renamed to `devcontainerx`**
8+
79
## Installation
810

911
Head to the [latest release page](https://github.com/stuartleeks/devcontainer-cli/releases/latest) and download the archive for your platform.
1012

11-
Extract `devcontainer` from the archive and place in a folder in your `PATH`.
13+
Extract `devcontainerx` from the archive and place in a folder in your `PATH`.
1214

1315
You can also install using `homebrew` with `brew install stuartleeks/tap/devcontainer`
1416

@@ -27,16 +29,16 @@ sudo -E ./install.sh
2729
To enable bash completion, add the following to you `~/.bashrc` file:
2830

2931
```bash
30-
source <(devcontainer completion bash)
32+
source <(devcontainerx completion bash)
3133
```
3234

33-
Or to alias `devcontainer` (to `dc` in this example):
35+
Or to alias `devcontainerx` (to `dcx` in this example):
3436

3537
```bash
36-
alias dc=devcontainer
37-
complete -F __start_devcontainer dc
38+
alias dcx=devcontainerx
39+
complete -F __start_devcontainerx dcx
3840
```
3941

4042
## Docs
4143

42-
See [the documentation](https://stuartleeks.github.io/devcontainer-cli) on how to work with `devcontainer`.
44+
See [the documentation](https://stuartleeks.github.io/devcontainer-cli) on how to work with `devcontainerx`.

0 commit comments

Comments
 (0)