> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/web-application-and-api-protection-waap/application-security-testing/ast-basics-and-workflow/runners-and-cli/cli-pre-checks-and-installation.md).

# 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:

   ```language-bash
   curl -0 https://downloads.traceable.ai/cli/release/v2/install.sh
   ```
2. Execute the command below to install the CLI:

   ```language-bash
   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:

   ```language-bash
   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:

   ```language-bash
   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                                                                      | <p>--hook-file</p><p>--token</p><p>-h/--traceable-server</p><p>-l/--loglevel</p>                                                                                                         |
| plugins      |                                                                                                                                                    | <p>--token</p><p>-h/--traceable-server</p><p>-l/--loglevel</p>            |                                                                                                                                                                                          |
| scan         | getEvaluationResult                                                                                                                                | <p>--id</p><p>--token</p><p>-h/--traceable-server</p><p>-l/--loglevel</p> |                                                                                                                                                                                          |
| initAndRun   | <p>-n/--scan-name</p><p>--token</p><p>-h/--traceable-server</p><p>-l/--loglevel</p>                                                                |                                                                           |                                                                                                                                                                                          |
| report       | <p>--id</p><p>--output-format</p><p>--output-file</p><p>--wait</p><p>--exit-code</p><p>--token</p><p>-h/--traceable-server</p><p>-l/--loglevel</p> |                                                                           |                                                                                                                                                                                          |
| code         | apis                                                                                                                                               |                                                                           | <p>-cp/--code-path</p><p>-cl/--code-language</p><p>-bp/--binary-path</p><p>-ml/--memory-limit</p><p>-a/--artifact-path</p><p>--token</p><p>-h/--traceable-server</p><p>-l/--loglevel</p> |
| login        |                                                                                                                                                    |                                                                           | <p>--clean</p><p>--config-file</p><p>--token</p><p>-h/--traceable-server</p><p>-l/--loglevel</p>                                                                                         |
| preflight    |                                                                                                                                                    |                                                                           | <p>-c/--check</p><p>-l/--loglevel</p>                                                                                                                                                    |
| runner       | start                                                                                                                                              |                                                                           | <p>--runner-name</p><p>--runner-labels</p><p>--environment-ids</p><p>--token</p><p>-h/--traceable-server</p><p>-l/--loglevel</p>                                                         |
| stop         |                                                                                                                                                    | <p>--token</p><p>-h/--traceable-server</p><p>-l/--loglevel</p>            |                                                                                                                                                                                          |
| version      |                                                                                                                                                    |                                                                           |                                                                                                                                                                                          |
