Skip to content

Latest commit

 

History

History
131 lines (82 loc) · 3.65 KB

INSTALLATION.md

File metadata and controls

131 lines (82 loc) · 3.65 KB

Installation

Package managers

Packaging status

macOS

The STACKIT CLI can be installed through the Homebrew package manager.

  1. First, you need to register the STACKIT tap via:
brew tap stackitcloud/tap
  1. You can then install the CLI via:
brew install stackit

Linux

Snapcraft

The STACKIT CLI is available as a Snap, and can be installed via:

sudo snap install stackit --beta --classic

or via the Snap Store for desktop.

Debian/Ubuntu (APT)

The STACKIT CLI can be installed through the APT package manager.

Before you begin

To install the STACKIT CLI package, you will need to have the curl and gnupg packages installed:

sudo apt-get update
sudo apt-get install curl gnupg
Installing
  1. Import the STACKIT public key:
curl https://packages.stackit.cloud/keys/key.gpg | sudo gpg --dearmor -o /usr/share/keyrings/stackit.gpg
  1. Add the STACKIT CLI package repository as a package source:
echo "deb [signed-by=/usr/share/keyrings/stackit.gpg] https://packages.stackit.cloud/apt/cli stackit main" | sudo tee -a /etc/apt/sources.list.d/stackit.list
  1. Update repository information and install the stackit package:
sudo apt-get update
sudo apt-get install stackit

If you can't install the stackit package due to an expired key, please go back to step 1 to import the latest public key.

Nix / NixOS

The STACKIT CLI is available as a Nix package, and can be used via:

nix-shell -p stackit-cli

Eget

The STACKIT CLI binaries are available via our GitHub releases, you can install them from there using Eget.

# ~/.eget.toml
["stackitcloud/stackit-cli"]
asset_filters=["stackit-cli_", "_linux_amd64.tar.gz"]
eget stackitcloud/stackit-cli

Any distribution

Alternatively, you can install via Homebrew or refer to one of the installation methods below.

We are currently working on distributing the CLI on more package managers for Linux.

Windows

We are currently working on distributing the CLI on a package manager for Windows. For the moment, please refer to one of the installation methods below.

Manual installation

You can also get the STACKIT CLI by compiling it from source or downloading a pre-compiled binary.

Compile from source

  1. Clone the repository

  2. Build the application locally by running:

    make build

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

    ./bin/stackit <GROUP> <SUB-GROUP> <COMMAND> <ARGUMENT> <FLAGS>

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

    go run . <GROUP> <SUB-GROUP> <COMMAND> <ARGUMENT> <FLAGS>

Pre-compiled binary

  1. Download the binary corresponding to your operating system and CPU architecture from our Releases page
  2. Extract the contents of the file to your file system and move it to your preferred location (make sure the directory is added to your PATH)