---
title: "CLI Pre-checks and Installation"
slug: "cli-installation"
description: "Learn how to install the Traceable CLI and run pre-checks to validate system readiness. Understand CLI setup, environment validation, and available commands for reliable scan execution."
updated: 2025-12-29T05:10:33Z
published: 2025-12-29T05:10:33Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://traceabledocs.document360.io/llms.txt
> Use this file to discover all available pages before exploring further.

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

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

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

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

```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 | --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 |  |  |  |

## Related

- [Runners and CLI](/runners.md)
- [Software and Hardware Requirements](/software-and-hardware-requirements.md)
- [Installing a Runner](/installing-a-runner.md)
- [Understanding Runners Dashboard](/understanding-runner-dashboard.md)
- [Uninstalling a Runner](/uninstalling-a-runner.md)