You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
6
8
7
9
1. First, you need to register the [STACKIT tap](https://github.com/stackitcloud/homebrew-tap) via:
8
10
@@ -13,44 +15,54 @@ brew tap stackitcloud/tap
13
15
2. You can then install the CLI via:
14
16
15
17
```shell
16
-
brew install stackit-cli
18
+
brew install stackit
17
19
```
18
20
19
-
## Linux
21
+
###Linux
20
22
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.
22
24
23
-
## Windows
25
+
###Windows
24
26
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.
26
28
27
29
## Manual installation
28
30
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.
30
32
31
-
### Pre-compiled binary
33
+
### Compile from source
32
34
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:
36
36
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:
38
44
39
45
1. Clone the repository
40
46
2. Build the application locally by running:
41
47
42
48
```bash
43
-
$ make build
49
+
make build
44
50
```
45
51
46
52
To use the application from the root of the repository, you can run:
3. Skip building and run the Go application directly using:
53
59
54
60
```bash
55
-
$ go run .<GROUP><SUB-GROUP><COMMAND><ARGUMENT><FLAGS>
61
+
go run .<GROUP><SUB-GROUP><COMMAND><ARGUMENT><FLAGS>
56
62
```
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
Copy file name to clipboardExpand all lines: README.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,15 +76,15 @@ After successful authentication, the CLI stores credentials in your OS keychain.
76
76
To authenticate as a user, run the command below and follow the steps in your browser.
77
77
78
78
```bash
79
-
$ stackit auth login
79
+
stackit auth login
80
80
```
81
81
82
82
### Activate a service account
83
83
84
84
To authenticate using a service account, run:
85
85
86
86
```bash
87
-
$ stackit auth activate-service-account
87
+
stackit auth activate-service-account
88
88
```
89
89
90
90
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
94
94
You can configure the CLI using the command:
95
95
96
96
```bash
97
-
$ stackit config
97
+
stackit config
98
98
```
99
99
100
100
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:
101
101
102
102
```bash
103
-
$ stackit config set --project-id xxxx-xxxx-xxxxx
103
+
stackit config set --project-id xxxx-xxxx-xxxxx
104
104
```
105
105
106
106
To remove it, you can run:
107
107
108
108
```bash
109
-
$ stackit config unset --project-id
109
+
stackit config unset --project-id
110
110
```
111
111
112
112
Run the `config set` command with the flag `--help` to get a list of all of the available configuration options.
113
113
114
114
You can lookup your current configuration by checking the configuration file or by running:
115
115
116
116
```bash
117
-
$ stackit config list
117
+
stackit config list
118
118
```
119
119
120
120
You can also edit the configuration file manually.
0 commit comments