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

Download the latest package and installation script:

curl -o- https://downloads.traceable.ai/cli/release/v2/install.sh | bash

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

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
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	Traceable Actions Commands	Traceable Actions Sub-Commands	Flags
ast	hook	test	--hook-file
	plugins		-l, --loglevel --token -h, --traceable-server
	scan	abort	--noprompt -l, --loglevel
		cloneAndRun
		getEvaluationResult	--traceable-server
		init
		initAndRun
		report	-f, --output-format -o, --output-file --exit-code
		resume	--id --experimental-test-results-upload-enabled -h, --traceable-server
		retest	--max-retries --processes --should-upload-logs
		run	-n, --scan-name -st, --scan-tag -r, --reference-env --scan-timeout --delay-between-requests -bi, --build-id -bu, --build-url --start-zapproxy --wait --exit-code --force --max-retries --last-timestamp
		stop	--all --noprompt
code	apis		-cp, --code-path -cl, --code-language -bp, --binary-path (default: /app/code-analysis/joern) -ml, --memory-limit (default: 80) -a, --artifact-path --token -h, --traceable-server (default: api.traceable.ai:443) -l, --loglevel (default: INFO)
login			--token -h, --traceable-server --clean -l, --loglevel -conf, --config-file
runner	start		-n, --runner-name -conf, --config-file -set, --set-config --logfile --processes --scan-max-retention-count --scan-max-retention-days --environment-ids -l, --loglevel -h, --traceable-server
runner	stop		--help
version			--help