Skip to content

Commit 0a69dfa

Browse files
authored
Add INSTALLATION guide (#37)
* Add INSTALLATION guide * Mention Homebrew for Linux users
1 parent 624973c commit 0a69dfa

File tree

2 files changed

+57
-27
lines changed

2 files changed

+57
-27
lines changed

INSTALLATION.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Installation
2+
3+
## macOS
4+
5+
The STACKIT CLI is available to download and install through the [Homebrew](https://brew.sh/) package manager.
6+
7+
1. First, you need to register the [STACKIT tap](https://github.com/stackitcloud/homebrew-tap) via:
8+
9+
```shell
10+
brew tap stackitcloud/tap
11+
```
12+
13+
2. You can then install the CLI via:
14+
15+
```shell
16+
brew install stackit-cli
17+
```
18+
19+
## Linux
20+
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.
22+
23+
## Windows
24+
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.
26+
27+
## Manual installation
28+
29+
Alternatively, you can get the STACKIT CLI by downloading a pre-compiled binary or compiling it from source.
30+
31+
### Pre-compiled binary
32+
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
36+
37+
### Compile from source
38+
39+
1. Clone the repository
40+
2. Build the application locally by running:
41+
42+
```bash
43+
$ make build
44+
```
45+
46+
To use the application from the root of the repository, you can run:
47+
48+
```bash
49+
$ ./bin/stackit <GROUP> <SUB-GROUP> <COMMAND> <ARGUMENT> <FLAGS>
50+
```
51+
52+
3. Skip building and run the Go application directly using:
53+
54+
```bash
55+
$ go run . <GROUP> <SUB-GROUP> <COMMAND> <ARGUMENT> <FLAGS>
56+
```

README.md

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,33 +7,7 @@ Your feedback is appreciated!
77

88
## Installation
99

10-
To get started using it, you can:
11-
12-
1. Download the binary corresponding to your operating system and CPU architecture
13-
2. Extract the contents of the file to your file system and move it to your preferred location (e.g. your home directory)
14-
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
15-
16-
Alternatively, you can use the STACKIT CLI by cloning the repository and either:
17-
18-
1. Build the application locally by running:
19-
20-
```bash
21-
$ go build -o ./bin/stackit
22-
```
23-
24-
To use the application from the root of the repository, you can run:
25-
26-
```bash
27-
$ ./bin/stackit <GROUP> <SUB-GROUP> <COMMAND> <ARGUMENT> <FLAGS>
28-
```
29-
30-
2. Skip building and run the Go application directly using:
31-
32-
```bash
33-
$ go run . <GROUP> <SUB-GROUP> <COMMAND> <ARGUMENT> <FLAGS>
34-
```
35-
36-
We also plan to integrate the STACKIT CLI on package managers such as APT and Brew.
10+
Please refer to our [installation](./INSTALLATION.md) guide for instructions on how to install and get started using the STACKIT CLI.
3711

3812
## Usage
3913

0 commit comments

Comments
 (0)