User guide

The STACKIT CLI is the command-line interface for managing STACKIT services. You can use it to configure and perform various actions for supported services. You’ll find a list of available services in the official documentation on GitHub.

STACKIT CLI on GitHub

Find the latest and most comprehensive documentation on STACKIT CLI directly in our repo.

Getting started

1. Install STACKIT CLI on your computer
   Before you can use the STACKIT CLI, you must install it on your computer. There are specific installation methods for different operating systems. For installation instructions, see the Installation guide.
2. Configure your STACKIT CLI
   Learn how to manage STACKIT CLI settings in the Configuration section of the GitHub documentation. This guide explains how to use the stackit config command to set or unset default values.
3. Customize your output
   You can customize how the output is displayed. Refer to the Customization section to learn how to configure a custom pager using the PAGER environment variable and the default settings used by the less pager.
4. Enable autocompletion (optional)
   You can set up command autocompletion in your shell for the STACKIT CLI. The Autocompletion guide describes how to enable command autocompletion for the STACKIT CLI by leveraging the functionality provided by the Cobra framework.

Usage

See how to structure and use STACKIT CLI commands by reviewing the Usage section of the documentation. This section breaks down the anatomy of a command and its flags.

You can also explore the Available services for a list of all STACKIT services that are currently integrated with the CLI.

Authentication

Before using most commands, you’ll need to authenticate with the STACKIT CLI. The Authentication section of the documentation provides the necessary commands and information for logging in with either a personal user account or a service account.

Command reference

To see all available commands, flags, and their usage, run stackit --help or simply add the -h flag to any command you wish to inspect.

Explore the full range of available commands and their options in the Command reference. This comprehensive documentation provides detailed information on every STACKIT CLI command, helping you understand their usage and functionality.