Use the TestCollab CLI
The CLI connects feature files, test results, builds and plans to TestCollab.
Install and authenticate
Section titled “Install and authenticate”Use Node.js 22 or newer for these guides:
export TESTCOLLAB_TOKEN='your-api-token'tc --versionKeep the token in your CI secret store. For an EU account, include --api-url https://api-eu.testcollab.io in your commands.
Choose a command
Section titled “Choose a command”| Command | Workflow |
|---|---|
tc sync |
Synchronize Gherkin feature files with TestCollab |
tc createBuild |
Record the software build your pipeline produced |
tc createTestPlan |
Create a plan from CI-tagged cases and assign it |
tc getTestPlan |
Read a plan and execution context as JSON |
tc report |
Upload JUnit XML or Mochawesome JSON results |
tc reportCase |
Report one exact execution, with optional evidence |
tc gate |
Evaluate a plan’s results and exit nonzero when the gate fails |
Each command has its own help:
tc report --helptc gate --helpStart with a read
Section titled “Start with a read”tc getTestPlan --project 123 --test-plan-id 456 --output ./plan.jsonThen choose CI reporting or BDD sync.
The CLI and SDK are separate packages. Installing the CLI does not require you to regenerate an SDK or download an API specification.