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

# Hex CLI

> Trigger Hex project runs and list available projects from Paradime Bolt using the paradime run hex-trigger CLI commands with real-time run monitoring.

The Paradime SDK provides CLI commands to interact with Hex, allowing you to trigger project runs and list available projects in your workspace.

<Warning>
  🔑 **API Access Required**

  You will need a Hex API token to use these commands. You can find this in your Hex workspace settings.

  You can set your token as the `HEX_API_TOKEN` environment variable so you don't have to pass `--api-token` on every command.
</Warning>

## Trigger Hex Project Runs

Trigger runs for Hex projects.

### CLI Command

```bash theme={"system"}
paradime run hex-trigger
```

**Options**

| Flag                                           | Type                             | Description                                                                                  |
| ---------------------------------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- |
| `--api-token`                                  | Required, TEXT                   | Your Hex API token. You can find this in your Hex workspace settings. `[env: HEX_API_TOKEN]` |
| `--base-url`                                   | Optional, TEXT                   | Hex base URL. Default: [https://app.hex.tech](https://app.hex.tech) `[env: HEX_BASE_URL]`    |
| `--project-ids`                                | Required, TEXT (comma-separated) | Comma-separated project ID(s) to trigger                                                     |
| `--input-param`                                | Optional, TEXT (multiple)        | Input parameters in key=value format (can be used multiple times)                            |
| `--update-published` / `--no-update-published` | Optional, Flag                   | Update cached app state with run results. Default: `--update-published`.                     |
| `--wait` / `--no-wait`                         | Optional, Flag                   | Wait for runs to complete before returning (default: True) `[env: HEX_TRIGGER_WAIT]`         |
| `--timeout`                                    | Optional, INTEGER                | Maximum time to wait in minutes. Default: `1440`. `[env: HEX_TRIGGER_TIMEOUT]`               |
| `--json`                                       | Optional, Flag                   | Output results as JSON. Default: `False`.                                                    |
| `--help`                                       | Optional, Flag                   | Show the help message and exit.                                                              |

### Examples

```bash theme={"system"}
# Using the HEX_API_TOKEN environment variable (recommended)
paradime run hex-trigger --project-ids "abc-123,def-456"

# Trigger a run with input parameters
paradime run hex-trigger \
  --project-ids "abc-123" \
  --input-param "region=us-east" \
  --input-param "limit=100"

# Trigger a run without updating the published app state
paradime run hex-trigger \
  --project-ids "abc-123" \
  --no-update-published
```

## List Hex Projects

List all available Hex projects in the workspace.

### CLI Command

```bash theme={"system"}
paradime run hex-list-projects
```

**Options**

| Flag                 | Type              | Description                                                                                  |
| -------------------- | ----------------- | -------------------------------------------------------------------------------------------- |
| `--api-token`        | Required, TEXT    | Your Hex API token. You can find this in your Hex workspace settings. `[env: HEX_API_TOKEN]` |
| `--base-url`         | Optional, TEXT    | Hex base URL. Default: [https://app.hex.tech](https://app.hex.tech) `[env: HEX_BASE_URL]`    |
| `--limit`            | Optional, INTEGER | Number of projects to fetch (default: 100)                                                   |
| `--include-archived` | Optional, Flag    | Include archived projects. Default: `False`.                                                 |
| `--include-trashed`  | Optional, Flag    | Include trashed projects. Default: `False`.                                                  |
| `--json`             | Optional, Flag    | Output results as JSON. Default: `False`.                                                    |
| `--help`             | Optional, Flag    | Show the help message and exit.                                                              |

### Examples

```bash theme={"system"}
# List all Hex projects
paradime run hex-list-projects

# Include archived and trashed projects
paradime run hex-list-projects \
  --include-archived \
  --include-trashed

# Output as JSON
paradime run hex-list-projects --json
```

## Environment Variable Reference

| Environment Variable  | Description                                                          |
| --------------------- | -------------------------------------------------------------------- |
| `HEX_API_TOKEN`       | Your Hex API token                                                   |
| `HEX_BASE_URL`        | Hex base URL (default: [https://app.hex.tech](https://app.hex.tech)) |
| `HEX_TRIGGER_WAIT`    | Whether to wait for runs to complete (`hex-trigger`)                 |
| `HEX_TRIGGER_TIMEOUT` | Maximum time to wait in minutes (`hex-trigger`)                      |


## Related topics

- [Trigger Hex Projects](/products/bolt/creating-schedules/templates/dashboard-templates/trigger-hex-projects.md)
- [Dashboard Templates](/products/bolt/creating-schedules/templates/dashboard-templates/index.md)
- [Sankey Diagrams](/integrations/mermaid-js/sankey-diagrams.md)
- [Bolt CLI](/developers/paradime-cli/bolt-cli.md)
- [Paradime CLI](/developers/paradime-cli/index.md)