CLI Pre-checks and Installation

The Traceable CLI is a core component used to initiate scans, perform validations, and interact with the Traceable platform. Its behavior and reliability depend on the underlying system being correctly set up and accessible.

What will you learn in this topic?

By the end of this topic, you will understand:

• The steps to install the CLI on your system.

• The commands and options available for use post-installation.

---

Installing the CLI

1. Download the latest package and installation script:

   curl -0 https://downloads.traceable.ai/cli/release/v2/install.sh

2. Execute the command below to install the CLI:

   bash install.sh --service --token <traceable-api-token> --server <traceable-server>
   # Replace the <traceable-api-token> and <traceable-server> placeholders with the actual values

3. Execute the following command to perform pre-checks:

   traceable preflight

   As part of the above command, Traceable checks the status of the following components:

   • OS version

   • User info

   • Write access

   • Disk capacity

   • Memory capacity

   • CPU capacity

   • Fork capabilities

   • Internet connectivity

   • Traceable server reachability

4. Execute the following command to verify the CLI installation:

   traceable version

---

Traceable commands and options

Traceable provides the following commands and options that you can use with the CLI:

Core command	Command	Sub-command	Flags
ast	hook	test	--hook-file
	plugins		general CLI options
	scan	initAndRun	-n / —-scan-name override flags
		queue	-n / —-scan-name --scan-id --runner-ids --runner-name --runner-labels --wait --wait-timeout --exit-code override flags
		report	--id --output-format --output-file --wait --exit-code
		getEvaluationResult	--id
code	apis	—	-cp / --code-path -cl / --code-language -bp / --binary-path -ml / --memory-limit -a / --artifact-path
login	—	—	--clean --config-file
preflight	—	—	-c / --check
runner	start	—	--runner-name --runner-labels --environment-ids
	stop	—	general CLI options
version	—	—	—