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

# Commands

> Reference for all Evidence CLI commands.

## Development

### `evidence init`

Scaffold a new Evidence project.

```bash theme={null}
evidence init my-project
evidence init my-project --warehouse snowflake
```

| Option        | Description                                                                                                                                |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `--warehouse` | Scaffold a `connection.yaml` for a direct warehouse connection: `snowflake` or `bigquery`. See [Connecting a Warehouse](/cli/connections). |

Without `--warehouse`, the project uses the managed Evidence Warehouse. With it, the CLI writes a `connection.yaml` (gitignored) so queries run directly against your own warehouse.

### `evidence dev`

Start the local development server.

```bash theme={null}
evidence dev
evidence dev --port 8080
```

| Option         | Description                    |
| -------------- | ------------------------------ |
| `--port`, `-p` | Port to run on (default: 3000) |

## Deploy

### `evidence launch`

Connect this project to Evidence Studio and GitHub, then deploy by pushing to your repo. Interactive by default — it walks you through installing the GitHub App and creating (or linking) the Studio project.

```bash theme={null}
evidence launch
evidence launch --name "My Project" --upload-credentials
```

| Option                 | Description                                                                                                                                                         |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--name`               | Name for the Studio project to create.                                                                                                                              |
| `--branch`             | Branch to publish from (default: auto-detected).                                                                                                                    |
| `--root-directory`     | Project root within the repo (default: auto-detected).                                                                                                              |
| `--upload-credentials` | Upload warehouse credentials from [`connection.yaml`](/cli/connections) to your org. Prompted for interactively; required to opt in when running non-interactively. |

### `evidence link`

Attach this repo to an **existing** Studio project. The project's content becomes git-managed — the next `git push` overwrites it with the repo's contents.

```bash theme={null}
evidence link my-project
evidence link --project my-project
```

| Option             | Description                                                                      |
| ------------------ | -------------------------------------------------------------------------------- |
| `--project`        | Studio project to attach, by slug or id. Also accepted as a positional argument. |
| `--branch`         | Branch to publish from (default: auto-detected).                                 |
| `--root-directory` | Project root within the repo (default: auto-detected).                           |

### `evidence unlink`

Disconnect this repo from its Studio project. The org's GitHub App install and the project itself are left intact.

```bash theme={null}
evidence unlink
evidence unlink --project my-project
```

| Option      | Description                                                                                                                     |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `--project` | Studio project to unlink, by slug or id. Inferred from the repo's binding when omitted. Also accepted as a positional argument. |

## Data

### `evidence query`

Run a SQL query against connected data sources.

```bash theme={null}
evidence query "SELECT * FROM orders LIMIT 10"
evidence query --file query.sql
cat query.sql | evidence query -
```

| Option           | Description                                              |
| ---------------- | -------------------------------------------------------- |
| `--format`       | Output format: `json` (default), `jsonl`, `table`, `csv` |
| `--limit`, `-l`  | Limit number of rows                                     |
| `--quiet`, `-q`  | Suppress status messages                                 |
| `--columns`      | Output only column names and types                       |
| `--file`         | Read SQL from a file                                     |
| `--output`, `-o` | Write results to a file                                  |

### `evidence tables`

List available data tables.

```bash theme={null}
evidence tables
```

### `evidence describe`

Show schema for a table.

```bash theme={null}
evidence describe demo_daily_orders
```

### `evidence schema`

Show all tables with their columns.

```bash theme={null}
evidence schema
```

### `evidence connectors`

List all connectors with health status.

```bash theme={null}
evidence connectors
evidence connectors --json
```

Shows connector name, type, status, last sync, schedule, table count, and reference count for all connector types.

### `evidence models`

List all models with refresh status.

```bash theme={null}
evidence models
evidence models --json
```

Shows model name, status, last refresh time, and schedule.

### `evidence lineage`

Show where connections and tables are used across projects, pages, models, and queries.

```bash theme={null}
evidence lineage
evidence lineage table orders
evidence lineage --branch dev/alex
evidence lineage --json
```

| Option         | Description                               |
| -------------- | ----------------------------------------- |
| `table <name>` | Show where a specific table is referenced |
| `--branch`     | Query a specific branch (default: main)   |
| `--json`       | Output JSON for tooling                   |

## Project

### `evidence validate`

Validate all markdown files in the current project.

```bash theme={null}
evidence validate
evidence validate --json
```

### `evidence docs`

Browse and search component documentation.

```bash theme={null}
evidence docs                         # Overview
evidence docs search "chart"          # Search docs
evidence docs component bar_chart     # Component details
```

## Authentication

### `evidence signup`

Create an account and workspace. Opens Evidence in your browser; once done, run `evidence login` to connect the CLI.

```bash theme={null}
evidence signup
```

### `evidence login`

Authenticate with Evidence Studio using your browser.

```bash theme={null}
evidence login
```

### `evidence logout`

Clear stored credentials.

```bash theme={null}
evidence logout
```

### `evidence whoami`

Show the currently authenticated user.

```bash theme={null}
evidence whoami
```

### `evidence orgs`

List available organizations.

```bash theme={null}
evidence orgs
```

### `evidence switch`

Switch to a different organization.

```bash theme={null}
evidence switch "My Organization"
```

### `evidence token`

Generate a token for headless/CI use. Prints an `EVIDENCE_AUTH_TOKEN` value you can set as an environment variable to authenticate without an interactive login. Requires an active login and a selected organization.

```bash theme={null}
evidence token
```

<Warning>
  The generated token contains a long-lived access token. Treat it as a secret.
</Warning>

## Utility

### `evidence version`

Print the current CLI version.

```bash theme={null}
evidence version
```

### `evidence upgrade`

Upgrade to the latest CLI version.

```bash theme={null}
evidence upgrade
```

### `evidence help`

Show help and available commands.

```bash theme={null}
evidence help
```
