Merge pull request #75 from stuartleeks/sl/rename-devcontainerx

Update binary to devcontainerx

.gitignore

@@ -1,2 +1,3 @@
 /devcontainer
+/devcontainerx
 /dist

.goreleaser.yml

@@ -1,15 +1,15 @@
 builds:
 - env:
   - CGO_ENABLED=0
-  binary: devcontainer
+  binary: devcontainerx
   goos:
     - linux
     - darwin
     - windows
   goarch:
     - 386
     - amd64
-  main: ./cmd/devcontainer/
+  main: ./cmd/devcontainerx/
   ldflags:
     - -s -w -X main.version={{.Version}} -X main.commit={{.ShortCommit}} -X main.date={{.Date}} -X "main.goversion={{.Env.GOVERSION}}"
 
@@ -29,9 +29,9 @@ brews:
     homepage: https://github.com/stuartleeks/devcontainer-cli
     description: CLI for working with Visual Studio Code devcontainers
     install: |
-      bin.install "devcontainer" 
+      bin.install "devcontainerx"
     test: |
-      system "#{bin}/devcontainer --version"
+      system "#{bin}/devcontainerx --version"
 
 changelog:
   sort: asc

Makefile

@@ -6,7 +6,7 @@ help: ## show this help
 
 
 build: fmt ## Build devcontainer cli
-	go build ./cmd/devcontainer
+	go build ./cmd/devcontainerx
 
 lint: build ## Build and lint
 	golangci-lint run

README.md

@@ -4,11 +4,13 @@ devcontainer-cli is the start of a CLI to improve the experience of working with
 
 **Status: this is a pet project that I've been experimenting with. It is not supported and you should expect bugs :-)**
 
+**NOTE: To avoid conflicts with the [official CLI](https://github.com/devcontainers/cli) the binary for this project has been renamed to `devcontainerx`**
+
 ## Installation
 
 Head to the [latest release page](https://github.com/stuartleeks/devcontainer-cli/releases/latest) and download the archive for your platform.
 
-Extract `devcontainer` from the archive and place in a folder in your `PATH`.
+Extract `devcontainerx` from the archive and place in a folder in your `PATH`.
 
 You can also install using `homebrew` with `brew install stuartleeks/tap/devcontainer`
 
@@ -27,16 +29,16 @@ sudo -E ./install.sh
 To enable bash completion, add the following to you `~/.bashrc` file:
 
 ```bash
-source <(devcontainer completion bash)
+source <(devcontainerx completion bash)
 ```
 
-Or to alias `devcontainer` (to `dc` in this example):
+Or to alias `devcontainerx` (to `dcx` in this example):
 
 ```bash
-alias dc=devcontainer
-complete -F __start_devcontainer dc
+alias dcx=devcontainerx
+complete -F __start_devcontainerx dcx
 ```
 
 ## Docs
 
-See [the documentation](https://stuartleeks.github.io/devcontainer-cli)  on how to work with `devcontainer`.
+See [the documentation](https://stuartleeks.github.io/devcontainer-cli)  on how to work with `devcontainerx`.

cmd/devcontainer/completion.go → cmd/devcontainerx/completion.go

@@ -14,18 +14,18 @@ func createCompleteCommand(rootCmd *cobra.Command) *cobra.Command {
 		Short: "Generates bash completion scripts",
 		Long: `To load completion run
 	
-	. <(devcontainer completion SHELL)
+	. <(devcontainerx completion SHELL)
 
 	Valid values for SHELL are : bash, fish, powershell, zsh
 	
 	For example, to configure your bash shell to load completions for each session add to your bashrc
 	
 	# ~/.bashrc or ~/.profile
-	source <(devcontainer completion)
+	source <(devcontainerx completion)
 
 	# if you want to alias the CLI:
-	alias dc=devcontainer
-    source <(devcontainer completion bash | sed s/devcontainer/dc/g)
+	alias dcx=devcontainerx
+    source <(devcontainerx completion bash | sed s/devcontainerx/dcx/g)
 
 	`,
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {

cmd/devcontainer/main.go → cmd/devcontainerx/main.go

@@ -17,7 +17,7 @@ var (
 func main() {
 
 	rootCmd := &cobra.Command{
-		Use: "devcontainer",
+		Use: "devcontainerx",
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {
 			update.PeriodicCheckForUpdate(version)
 		},

scripts/install.sh

@@ -20,5 +20,5 @@ LATEST_VERSION=$(curl --silent "https://api.github.com/repos/stuartleeks/devcont
 echo $LATEST_VERSION
 mkdir -p ~/bin
 wget https://github.com/stuartleeks/devcontainer-cli/releases/download/${LATEST_VERSION}/devcontainer-cli_${OS}_${ARCH}.tar.gz
-tar -C ~/bin -zxvf devcontainer-cli_${OS}_${ARCH}.tar.gz devcontainer
-chmod +x ~/bin/devcontainer
+tar -C ~/bin -zxvf devcontainer-cli_${OS}_${ARCH}.tar.gz devcontainerx
+chmod +x ~/bin/devcontainerx