tSM CLI

tsm is the command-line tool for tSM. With it you can:

• read data and settings from a tSM environment,
• create, check and install configuration packages,
• do all of the above from scripts and CI pipelines.

Start here

1. Quick start: configuration repository: connect with an API key and start working with an existing configuration checkout.
2. Command builder: select a command, fill in its options and copy it to your terminal.
3. Install and connect: install tsm and connect it to your tSM environment (about 5 minutes).
4. Concepts: how projects, environments, accounts, contexts and workspaces fit together.

Guides by task

I want to…	Guide
Add another environment, account or tenant	Connections and authentication
Work with a Git checkout of a project	Workspaces
Read data, forms and services of an application	Application access
Create and install configuration packages	Packages
Use tsm in scripts and CI	Automation
Look up a setting in the configuration files	Configuration
Fix an error	Troubleshooting

Help for any command

tsm --help
tsm app --help
tsm --version

Every command accepts --help. The command reference lists all commands and options, and the command builder puts a command together for you.

Commands print readable tables. Add --json or -o yaml when a script reads the output. If a command from this guide is unknown, your CLI is too old: update it with tsm cli upgrade.

Experimental: local runtime

Developers can also build and run tSM on their own machine, either the whole stack or a single service from the IDE. This is experimental and available only in the experimental CLI build; most users do not need it. See Local runtime.