Touca CLI
Touca CLI helps you run tests, manage your local test results and submit them to the Touca server.
Installing
Touca CLI is part of the Touca Python SDK. It is available
on PyPI and can be installed with pip or
Homebrew.
- PIP
- Homebrew
pip install touca
brew install touca
Supported Commands
Touca CLI supports the following commands:
| Command | Description |
|---|---|
touca help | Learn how to use different commands |
touca config | Manage your active configuration profile |
touca profile | Create and manage configuration profiles |
touca login | Set API credentials from the CLI |
touca check | Submit external test output to Touca server |
touca test | Run your Touca tests |
touca results | Manage local test results |
touca server | Install and manage your Touca server |
touca plugin | Install and manage custom CLI plugins |
touca run | Run tests on a dedicated test server |
touca version | Check your Touca CLI version |
Getting Help
You can run touca help to get this list. You can also use help with any
subcommand to learn about its supported options and arguments.
Checking the CLI Version
You can run touca version to check what version of Touca CLI you are using.
This command prints a warning if the version of your CLI is different from the
latest available version.