Skip to content

Commit 466f20e

Browse files
bzonbzon
authored
Update installation guide [ci skip]
1 parent d0e31a2 commit 466f20e

1 file changed

Lines changed: 28 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,40 @@ Get the download link of your preferred platform binary from [RELEASES](https://
2424
### OSX
2525

2626
```bash
27-
curl -Lo gitlabctl https://github.com/devopsctl/gitlabctl/releases/download/${VERSION}/gitlabctl-darwin-amd64 && chmod +x gitlabctl && sudo mv gitlabctl /usr/local/bin/
27+
GITLABCTL_BIN_DIR=$HOME/.gitlabctl/bin
28+
29+
mkdir -p $GITLABCTL_BIN_DIR && curl -Lo gitlabctl \
30+
https://github.com/devopsctl/gitlabctl/releases/download/v0.3.0/gitlabctl-darwin-amd64 \
31+
&& chmod +x gitlabctl \
32+
&& sudo mv gitlabctl $GITLABCTL_BIN_DIR
33+
34+
export PATH=$PATH:$GITLABCTL_BIN_DIR
35+
36+
# You can also append this export command in $HOME/.profile or similar SHELL file
37+
# to make sure it is included in your `$PATH` variable
38+
# automatically upon starting a new terminal session.
2839
```
2940

3041
### Linux
3142

3243
```bash
33-
curl -Lo gitlabctl https://github.com/devopsctl/gitlabctl/releases/download/${VERSION}/gitlabctl-linux-amd64 && chmod +x gitlabctl && sudo mv gitlabctl /usr/local/bin/
44+
GITLABCTL_BIN_DIR=$HOME/.gitlabctl/bin
45+
46+
mkdir -p $GITLABCTL_BIN_DIR && curl -Lo gitlabctl \
47+
https://github.com/devopsctl/gitlabctl/releases/download/v0.3.0/gitlabctl-linux-amd64 \
48+
&& chmod +x gitlabctl \
49+
&& sudo mv gitlabctl $GITLABCTL_BIN_DIR
50+
51+
export PATH=$PATH:$GITLABCTL_BIN_DIR
52+
53+
# You can also append this export command in $HOME/.profile or similar SHELL file
54+
# to make sure it is included in your `$PATH` variable
55+
# automatically upon starting a new terminal session.
3456
```
3557

3658
### Windows
3759

38-
Download the gitlabctl-windows-amd64.exe file, rename it to gitlabctl.exe and add it to your path.
60+
Download the gitlabctl-windows-amd64.exe file, rename it to gitlabctl.exe and add it to your Windows System Environment Variable `%PATH%`.
3961

4062
### Auto Complete
4163

@@ -54,12 +76,15 @@ Using `gitlabctl login` to fetch personal access token
5476

5577
```bash
5678
gitlabctl login
79+
5780
>> Enter gitlab host url: http://localhost:10080
5881
>> Enter gitlab username: root
5982
>> Enter gitlab password: *****
6083
/Users/jb/.gitlabctl.yaml file has been created by login command
6184
```
6285

86+
__Windows Users:__ password masking does not work in Git bash.
87+
6388
Using environment variables. See `gitlabctl -h`
6489

6590
### Using the help commands

0 commit comments

Comments
 (0)