CLI Pre-checks and Installation

Prev Next

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

Traceable Actions Commands

Traceable Actions Sub-Commands

Flags

ast

hook

test

--hook-file

--token

-h/--traceable-server

-l/--loglevel

plugins

--token

-h/--traceable-server

-l/--loglevel

scan

getEvaluationResult

--id

--token

-h/--traceable-server

-l/--loglevel

initAndRun

-n/--scan-name

--token

-h/--traceable-server

-l/--loglevel

report

--id

--output-format

--output-file

--wait

--exit-code

--token

-h/--traceable-server

-l/--loglevel

code

apis

-cp/--code-path

-cl/--code-language

-bp/--binary-path

-ml/--memory-limit

-a/--artifact-path

--token

-h/--traceable-server

-l/--loglevel

login

--clean

--config-file

--token

-h/--traceable-server

-l/--loglevel

preflight

-c/--check

-l/--loglevel

runner

start

--runner-name

--runner-labels

--environment-ids

--token

-h/--traceable-server

-l/--loglevel

stop

--token

-h/--traceable-server

-l/--loglevel

version