Skip to content

Commit 39277dc

Browse files
authored
Docs: Update INSTALLATION guide (#52)
* Update INSTALLATION guide * Fix typo
1 parent 78045d6 commit 39277dc

File tree

2 files changed

+34
-22
lines changed

2 files changed

+34
-22
lines changed

INSTALLATION.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
# Installation
22

3-
## macOS
3+
## Package managers
44

5-
The STACKIT CLI is available to download and install through the [Homebrew](https://brew.sh/) package manager.
5+
### macOS
6+
7+
The STACKIT CLI can be installed through the [Homebrew](https://brew.sh/) package manager.
68

79
1. First, you need to register the [STACKIT tap](https://github.com/stackitcloud/homebrew-tap) via:
810

@@ -13,44 +15,54 @@ brew tap stackitcloud/tap
1315
2. You can then install the CLI via:
1416

1517
```shell
16-
brew install stackit-cli
18+
brew install stackit
1719
```
1820

19-
## Linux
21+
### Linux
2022

21-
We will soon distribute the STACKIT CLI via [Snap](https://snapcraft.io/). For the moment, you can either install via [Homebrew](https://brew.sh/) or refer to the [manual installation](#manual-installation) guide.
23+
We are working on distributing the CLI using a package manager for Linux. For the moment, you can either install via [Homebrew](https://brew.sh/) or refer to the [manual installation](#manual-installation) guide.
2224

23-
## Windows
25+
### Windows
2426

25-
We will soon distribute the STACKIT CLI via [Chocolatey](https://chocolatey.org/). For the moment, please refer to the [manual installation](#manual-installation) guide.
27+
We are working on distributing the CLI using a package manager for Windows. For the moment, please refer to the [manual installation](#manual-installation) guide.
2628

2729
## Manual installation
2830

29-
Alternatively, you can get the STACKIT CLI by downloading a pre-compiled binary or compiling it from source.
31+
You can also get the STACKIT CLI by compiling it from source or downloading a pre-compiled binary.
3032

31-
### Pre-compiled binary
33+
### Compile from source
3234

33-
1. Download the binary corresponding to your operating system and CPU architecture from our [Releases](https://github.com/stackitcloud/stackit-cli/releases) page
34-
2. Extract the contents of the file to your file system and move it to your preferred location (e.g. your home directory)
35-
3. (For macOS only) Right click on the executable, select "Open". You will see a dialog stating the identity of the developer cannot be confirmed. Click on "Open" to allow the app to run on your Mac. We soon plan to certificate the STACKIT CLI to be trusted by macOS
35+
If you have Go 1.16+ installed, you can directly install via:
3636

37-
### Compile from source
37+
```shell
38+
go install github.com/stackitcloud/stackit-cli@latest
39+
```
40+
41+
> For more information, please refer to the [`go install` documentation](https://go.dev/ref/mod#go-install)
42+
43+
Alternativelly, you can:
3844

3945
1. Clone the repository
4046
2. Build the application locally by running:
4147

4248
```bash
43-
$ make build
49+
make build
4450
```
4551

4652
To use the application from the root of the repository, you can run:
4753

4854
```bash
49-
$ ./bin/stackit <GROUP> <SUB-GROUP> <COMMAND> <ARGUMENT> <FLAGS>
55+
./bin/stackit <GROUP> <SUB-GROUP> <COMMAND> <ARGUMENT> <FLAGS>
5056
```
5157

5258
3. Skip building and run the Go application directly using:
5359

5460
```bash
55-
$ go run . <GROUP> <SUB-GROUP> <COMMAND> <ARGUMENT> <FLAGS>
61+
go run . <GROUP> <SUB-GROUP> <COMMAND> <ARGUMENT> <FLAGS>
5662
```
63+
64+
### Pre-compiled binary
65+
66+
1. Download the binary corresponding to your operating system and CPU architecture from our [Releases](https://github.com/stackitcloud/stackit-cli/releases) page
67+
2. Extract the contents of the file to your file system and move it to your preferred location (e.g. your home directory)
68+
3. (For macOS only) Right click on the executable, select "Open". You will see a dialog stating the identity of the developer cannot be confirmed. Click on "Open" to allow the app to run on your Mac. We soon plan to certificate the STACKIT CLI to be trusted by macOS

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -76,15 +76,15 @@ After successful authentication, the CLI stores credentials in your OS keychain.
7676
To authenticate as a user, run the command below and follow the steps in your browser.
7777

7878
```bash
79-
$ stackit auth login
79+
stackit auth login
8080
```
8181

8282
### Activate a service account
8383

8484
To authenticate using a service account, run:
8585

8686
```bash
87-
$ stackit auth activate-service-account
87+
stackit auth activate-service-account
8888
```
8989

9090
For more details on how to setup authentication using a service account, check our [authentication guide](./AUTHENTICATION.md).
@@ -94,27 +94,27 @@ For more details on how to setup authentication using a service account, check o
9494
You can configure the CLI using the command:
9595

9696
```bash
97-
$ stackit config
97+
stackit config
9898
```
9999

100100
The configurations are stored in `~/stackit/cli-config.json` and are valid for all commands. For example, you can set a default `project-id` by running:
101101

102102
```bash
103-
$ stackit config set --project-id xxxx-xxxx-xxxxx
103+
stackit config set --project-id xxxx-xxxx-xxxxx
104104
```
105105

106106
To remove it, you can run:
107107

108108
```bash
109-
$ stackit config unset --project-id
109+
stackit config unset --project-id
110110
```
111111

112112
Run the `config set` command with the flag `--help` to get a list of all of the available configuration options.
113113

114114
You can lookup your current configuration by checking the configuration file or by running:
115115

116116
```bash
117-
$ stackit config list
117+
stackit config list
118118
```
119119

120120
You can also edit the configuration file manually.

0 commit comments

Comments
 (0)