Search documentation...

K

CLI Reference

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

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

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

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

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

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

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

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

Ready to get started?

Jump right in or a book a demo. Your first destination is always free.

Book a demoSign upBook a demo

Need help?

Our team is relentlessly focused on your success. Don't hesitate to reach out!

Feature requests?

We'd love to hear your suggestions for integrations and other features.

On this page

Was this page helpful?