diff --git a/README.md b/README.md index 5bc4832..71062b8 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,11 @@ [![Go Report Card](https://goreportcard.com/badge/github.com/devopsctl/gitlabctl)](https://goreportcard.com/report/github.com/devopsctl/gitlabctl) [![Waffle board](https://badge.waffle.io/devopsctl/gitlabctl.png?columns=all)](https://waffle.io/devopsctl/gitlabctl) +# NO MAINTENANCE NOTICE + +I don't maintain this repository anymore. Feel free to fork if needed. + + # [`gitlabctl`](https://devopsctl.github.io/gitlabctl/) Be a rockstar and efficiently manage your team's gitlab.org or [self-hosted Gitlab](https://about.gitlab.com/installation/) projects, groups, users and other resources. @@ -24,18 +29,40 @@ Get the download link of your preferred platform binary from [RELEASES](https:// ### OSX ```bash -curl -Lo gitlabctl https://github.com/devopsctl/gitlabctl/releases/download/${VERSION}/gitlabctl-darwin-amd64 && chmod +x gitlabctl && sudo mv gitlabctl /usr/local/bin/ +GITLABCTL_BIN_DIR=$HOME/.gitlabctl/bin + +mkdir -p $GITLABCTL_BIN_DIR && curl -Lo gitlabctl \ + https://github.com/devopsctl/gitlabctl/releases/download/v0.3.0/gitlabctl-darwin-amd64 \ + && chmod +x gitlabctl \ + && mv gitlabctl $GITLABCTL_BIN_DIR + +export PATH=$PATH:$GITLABCTL_BIN_DIR + +# You can also append this export command in $HOME/.profile or similar SHELL file +# to make sure it is included in your `$PATH` variable +# automatically upon starting a new terminal session. ``` ### Linux ```bash -curl -Lo gitlabctl https://github.com/devopsctl/gitlabctl/releases/download/${VERSION}/gitlabctl-linux-amd64 && chmod +x gitlabctl && sudo mv gitlabctl /usr/local/bin/ +GITLABCTL_BIN_DIR=$HOME/.gitlabctl/bin + +mkdir -p $GITLABCTL_BIN_DIR && curl -Lo gitlabctl \ + https://github.com/devopsctl/gitlabctl/releases/download/v0.3.0/gitlabctl-linux-amd64 \ + && chmod +x gitlabctl \ + && mv gitlabctl $GITLABCTL_BIN_DIR + +export PATH=$PATH:$GITLABCTL_BIN_DIR + +# You can also append this export command in $HOME/.profile or similar SHELL file +# to make sure it is included in your `$PATH` variable +# automatically upon starting a new terminal session. ``` ### Windows -Download the gitlabctl-windows-amd64.exe file, rename it to gitlabctl.exe and add it to your path. +Download the gitlabctl-windows-amd64.exe file, rename it to gitlabctl.exe and add it to your Windows System Environment Variable `%PATH%`. ### Auto Complete @@ -54,12 +81,15 @@ Using `gitlabctl login` to fetch personal access token ```bash gitlabctl login + >> Enter gitlab host url: http://localhost:10080 >> Enter gitlab username: root >> Enter gitlab password: ***** /Users/jb/.gitlabctl.yaml file has been created by login command ``` +__Windows Users:__ password masking does not work in Git bash. + Using environment variables. See `gitlabctl -h` ### Using the help commands