CLI Setup

This page covers the setup and general usage of the Tapitalee CLI that applies across most commands.

Installing the CLI

See Installing the CLI for per-platform download and install commands.

Authentication

Most commands require you to be authenticated. Run tapit login to initiate the login process. Your login token is stored in a config file.

To verify your current authentication state, run tapit status. This shows:

• Who you are logged in as
• Your default team and app
• The team’s subscription status and AWS account status (if configured)

You can override the config file path using the flag or environment variable:

--config_file value
TAPIT_CONFIG_FILE=value

Alternatively, you can authenticate using a deploy token or membership API token directly:

--token value
TAPIT_TOKEN=value

There are two types of tokens you can use:

• App Deploy Token — Scoped to a single app, primarily used to deploy it. These can be created from the Deploy Tokens page inside an app in the main Tapitalee dashboard.
• Membership Token — Authenticates the CLI to an entire team, with access to all apps and resources within it. These can be created under Team Members > Edit Member in the main Tapitalee dashboard.

See Deploy Tokens for more information on creating and managing tokens for CI/CD pipelines and automated workflows.

Specifying an App

Many commands require an app to be specified. Tapitalee will look for a tapit.toml file in the current working directory, which is set up by running tapit init.

You can also specify the app explicitly using the flag or environment variable:

--app value, -a value
TAPIT_APP=value

Common Flags

--ignore-existing

This flag can be used on most “create” commands. When set, the command will not return an error if a resource with that name already exists — it will simply continue without error. This is useful in idempotent scripts and CI/CD pipelines where the resource may have already been created.