Skip to content

INSTALLATION.md

Latest commit

 

History

History
183 lines (120 loc) · 5.18 KB

INSTALLATION.md

File metadata and controls

183 lines (120 loc) · 5.18 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 --cask stackit

Formula deprecated

The homebrew formula is deprecated, will no longer be updated and will be removed after 2026-01-22. You need to install the STACKIT CLI as cask.
Therefor you need to uninstall the formula and reinstall it as cask.

Your profiles should normally remain. To ensure that nothing will be gone, you should backup them.

  1. Export your existing profiles. This will create a json file in your current directory.
stackit config profile export default
  1. If you have multiple profiles, then execute the export command for each of them. You can find your profiles via:
stackit config profile list
stackit config profile export <profile-name>
  1. Uninstall the formula.
brew uninstall stackit
  1. Install the STACKIT CLI as cask.
brew install --cask stackit
  1. Check if your configs are still stored.
stackit config profile list
  1. In case the profiles are gone, import your profiles via:
$ stackit config profile import -c @default.json --name myProfile

Linux

Snapcraft

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

sudo snap install stackit --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

RPM package via dnf, yum and zypper

The STACKIT CLI is available as RPM Package and can be installed via dnf, yum and zypper package manager.

Just download the rpm package from the release page and run the install command like the following:

dnf install stackitcli.rpm
yum install stackitcli.rpm
zypper install stackitcli.rpm

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)