diff --git a/INSTALLATION.md b/INSTALLATION.md new file mode 100644 index 000000000..b2c5afe07 --- /dev/null +++ b/INSTALLATION.md @@ -0,0 +1,56 @@ +# Installation + +## macOS + +The STACKIT CLI is available to download and install through the [Homebrew](https://brew.sh/) package manager. + +1. First, you need to register the [STACKIT tap](https://github.com/stackitcloud/homebrew-tap) via: + +```shell +brew tap stackitcloud/tap +``` + +2. You can then install the CLI via: + +```shell +brew install stackit-cli +``` + +## Linux + +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. + +## Windows + +We will soon distribute the STACKIT CLI via [Chocolatey](https://chocolatey.org/). For the moment, please refer to the [manual installation](#manual-installation) guide. + +## Manual installation + +Alternatively, you can get the STACKIT CLI by downloading a pre-compiled binary or compiling it from source. + +### Pre-compiled binary + +1. Download the binary corresponding to your operating system and CPU architecture from our [Releases](https://github.com/stackitcloud/stackit-cli/releases) page +2. Extract the contents of the file to your file system and move it to your preferred location (e.g. your home directory) +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 + +### Compile from source + +1. Clone the repository +2. Build the application locally by running: + + ```bash + $ make build + ``` + + To use the application from the root of the repository, you can run: + + ```bash + $ ./bin/stackit + ``` + +3. Skip building and run the Go application directly using: + + ```bash + $ go run . + ``` diff --git a/README.md b/README.md index d7f3d7ed2..fdfc2ae57 100644 --- a/README.md +++ b/README.md @@ -7,33 +7,7 @@ Your feedback is appreciated! ## Installation -To get started using it, you can: - -1. Download the binary corresponding to your operating system and CPU architecture -2. Extract the contents of the file to your file system and move it to your preferred location (e.g. your home directory) -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 - -Alternatively, you can use the STACKIT CLI by cloning the repository and either: - -1. Build the application locally by running: - - ```bash - $ go build -o ./bin/stackit - ``` - - To use the application from the root of the repository, you can run: - - ```bash - $ ./bin/stackit - ``` - -2. Skip building and run the Go application directly using: - - ```bash - $ go run . - ``` - -We also plan to integrate the STACKIT CLI on package managers such as APT and Brew. +Please refer to our [installation](./INSTALLATION.md) guide for instructions on how to install and get started using the STACKIT CLI. ## Usage