Command Line Interface (CLI)

The Kapstan CLI can be used to interact with Kapstan services. Currently the CLI supports listing services and connecting to SQL databases.

Installation

Run the following command to install the Kapstan CLI. This will install the CLI and add it to your PATH.

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/kapstan-io/cli-installer/refs/heads/main/install.sh)"

After installation, you can run the following command to verify the installation:

kapstan version

Windows support for the Kapstan CLI is coming soon

First login and configure the CLI with the following commands:

kapstan login
kapstan configure

This will issue an access token and set the organization and environment for the CLI. By default the token expires in 24 hours.

Next, list the services in the current environment:

kapstan list services

Finally, connect to a service:

kapstan connect service -s [SERVICE_NAME]

See the CLI Reference for available commands and options.