Skip to content

Commit b4e7b43

Browse files
authored
Merge pull request #75 from stuartleeks/sl/rename-devcontainerx
Update binary to devcontainerx
2 parents 7b535df + 9e31590 commit b4e7b43

File tree

14 files changed

+21
-18
lines changed

14 files changed

+21
-18
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
/devcontainer
2+
/devcontainerx
23
/dist

.goreleaser.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
builds:
22
- env:
33
- CGO_ENABLED=0
4-
binary: devcontainer
4+
binary: devcontainerx
55
goos:
66
- linux
77
- darwin
88
- windows
99
goarch:
1010
- 386
1111
- amd64
12-
main: ./cmd/devcontainer/
12+
main: ./cmd/devcontainerx/
1313
ldflags:
1414
- -s -w -X main.version={{.Version}} -X main.commit={{.ShortCommit}} -X main.date={{.Date}} -X "main.goversion={{.Env.GOVERSION}}"
1515

@@ -29,9 +29,9 @@ brews:
2929
homepage: https://github.com/stuartleeks/devcontainer-cli
3030
description: CLI for working with Visual Studio Code devcontainers
3131
install: |
32-
bin.install "devcontainer"
32+
bin.install "devcontainerx"
3333
test: |
34-
system "#{bin}/devcontainer --version"
34+
system "#{bin}/devcontainerx --version"
3535
3636
changelog:
3737
sort: asc

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ help: ## show this help
66

77

88
build: fmt ## Build devcontainer cli
9-
go build ./cmd/devcontainer
9+
go build ./cmd/devcontainerx
1010

1111
lint: build ## Build and lint
1212
golangci-lint run

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`.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@ func createCompleteCommand(rootCmd *cobra.Command) *cobra.Command {
1414
Short: "Generates bash completion scripts",
1515
Long: `To load completion run
1616
17-
. <(devcontainer completion SHELL)
17+
. <(devcontainerx completion SHELL)
1818
1919
Valid values for SHELL are : bash, fish, powershell, zsh
2020
2121
For example, to configure your bash shell to load completions for each session add to your bashrc
2222
2323
# ~/.bashrc or ~/.profile
24-
source <(devcontainer completion)
24+
source <(devcontainerx completion)
2525
2626
# if you want to alias the CLI:
27-
alias dc=devcontainer
28-
source <(devcontainer completion bash | sed s/devcontainer/dc/g)
27+
alias dcx=devcontainerx
28+
source <(devcontainerx completion bash | sed s/devcontainerx/dcx/g)
2929
3030
`,
3131
PersistentPreRun: func(cmd *cobra.Command, args []string) {
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ var (
1717
func main() {
1818

1919
rootCmd := &cobra.Command{
20-
Use: "devcontainer",
20+
Use: "devcontainerx",
2121
PersistentPreRun: func(cmd *cobra.Command, args []string) {
2222
update.PeriodicCheckForUpdate(version)
2323
},

0 commit comments

Comments
 (0)