The Traceable CLI is a command-line interface that allows you to interact with the Traceable platform from your own environment. It enables you to initiate API testing scans and interact with Traceable services programmatically.
To ensure reliable execution, the system in which you run the CLI must meet specific compatibility considerations related to hardware resources, software components, and operating system support.
Hardware considerations
The Traceable CLI does not impose strict hardware requirements; however, adequate system resources are essential for stable operation. Resource needs can vary based on the size and complexity of the tasks being executed. Ensuring sufficient CPU and memory resources helps prevent performance degradation or incomplete execution.
The following table highlights the recommended configuration:
Number of Tests → | 1k Tests | 10k Tests | 100k Tests | 300k Tests | 700k Tests | 1 Million Tests |
|---|---|---|---|---|---|---|
Deployment Model ↓ | ||||||
VM | 2 vCPU | 2 vCPU | 2 vCPU | 4 vCPU | - | - |
2GB RAM | 4GB RAM | 4GB RAM | 8GB RAM | - | - | |
Kubernetes | - | - | - | - | - | - |
Software and operating system compatibility
The Traceable CLI is designed to run across commonly used operating systems and environments, provided the required system libraries and runtime components are available. Compatibility depends on the operating system, system architecture, and the execution environment in which the CLI is installed.
Software considerations
Before using the CLI, verify that your system aligns with the supported combinations. The following table highlights the supported installation method and the corresponding dependencies:
Method | Dependencies |
|---|---|
Binary Installation |
|
Docker | Your system must be capable of running Docker containers. |
Operating system considerations
Traceable publishes binaries for x64 Linux, aarch64 Linux, and x64 macOS. If you are running on a different platform, you can use the Traceable Docker image available on the Docker Hub.