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

# CLI Reference

> Commands and options for the Hightouch CLI.

* [`ht destinations`](#ht-destinations)
* [`ht inspect RESOURCE`](#ht-inspect-resource)
* [`ht login`](#ht-login)
* [`ht models`](#ht-models)
* [`ht runs`](#ht-runs)
* [`ht sources`](#ht-sources)
* [`ht syncs`](#ht-syncs)
* [`ht trigger SYNC`](#ht-trigger-sync)

## `ht destinations`

List all destinations in current workspace

```
USAGE
  $ ht destinations

DESCRIPTION
  List all destinations in current workspace

ALIASES
  $ ht destination

EXAMPLES
  $ ht destinations
```

*See code: [src/commands/destinations.ts](https://github.com/hightouchio/cli/blob/v0.1.0/src/commands/destinations.ts)*

## `ht inspect RESOURCE`

Inspect resources in the current workspace

```
USAGE
  $ ht inspect [RESOURCE] -f <value>

ARGUMENTS
  RESOURCE  Resource ID

FLAGS
  -f, --format=<value>  (required) [default: json] Output format(yaml/json)

DESCRIPTION
  Inspect resources in the current workspace

EXAMPLES
  $ ht inspect model/run-user
```

*See code: [src/commands/inspect.ts](https://github.com/hightouchio/cli/blob/v0.1.0/src/commands/inspect.ts)*

## `ht login`

Login Hightouch with API key

```
USAGE
  $ ht login

DESCRIPTION
  Login Hightouch with API key

EXAMPLES
  $ ht login
```

*See code: [src/commands/login.ts](https://github.com/hightouchio/cli/blob/v0.1.0/src/commands/login.ts)*

## `ht models`

List all models in current workspace

```
USAGE
  $ ht models

DESCRIPTION
  List all models in current workspace

ALIASES
  $ ht model

EXAMPLES
  $ ht models
```

*See code: [src/commands/models.ts](https://github.com/hightouchio/cli/blob/v0.1.0/src/commands/models.ts)*

## `ht runs`

List all syncs run for a given sync

```
USAGE
  $ ht runs -s <value> [-l <value>]

FLAGS
  -l, --limit=<value>  [default: 5] Limit the number of runs to output
  -s, --sync=<value>   (required) Specify sync name to list runs

DESCRIPTION
  List all syncs run for a given sync

ALIASES
  $ ht run

EXAMPLES
  $ ht runs
```

*See code: [src/commands/runs.ts](https://github.com/hightouchio/cli/blob/v0.1.0/src/commands/runs.ts)*

## `ht sources`

List all sources in current workspace

```
USAGE
  $ ht sources

DESCRIPTION
  List all sources in current workspace

ALIASES
  $ ht source

EXAMPLES
  $ ht sources
```

*See code: [src/commands/sources.ts](https://github.com/hightouchio/cli/blob/v0.1.0/src/commands/sources.ts)*

## `ht syncs`

List all syncs in current workspace

```
USAGE
  $ ht syncs

DESCRIPTION
  List all syncs in current workspace

ALIASES
  $ ht sync

EXAMPLES
  $ ht syncs
```

*See code: [src/commands/syncs.ts](https://github.com/hightouchio/cli/blob/v0.1.0/src/commands/syncs.ts)*

## `ht trigger SYNC`

Trigger sync to run

```
USAGE
  $ ht trigger [SYNC] [-f] [-q]

ARGUMENTS
  SYNC  Sync ID

FLAGS
  -f, --full-sync  Whether to run a full sync
  -q, --quiet      Whether to show run progress

DESCRIPTION
  Trigger sync to run

EXAMPLES
  $ ht trigger --sync test123
```

*See code: [src/commands/trigger.ts](https://github.com/hightouchio/cli/blob/v0.1.0/src/commands/trigger.ts)*
