Hightouch CLI to list, inspect resources and trigger syncs
- To install cli from curl script, run
curl -sLf https://raw.githubusercontent.com/hightouchio/cli/main/install.sh | sh -To install from Github package, download the latest release from here.
-
Create an API key. Follow docs here.
-
Login CLI with API key.
$ ht login
Hightouch API key [************************************]:Note: you can override api key with this environment variable HIGHTOUCH_APIKEY=mykey.
- Hightouch CLI is ready to use!
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
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
Login hightouch with api key
USAGE
$ ht login
DESCRIPTION
Login hightouch with api key
EXAMPLES
$ ht login
See code: src/commands/login.ts
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
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
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
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
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
Hightouch cli is written in typescripts. To test or develop in local development:
-
Install latest LTS nodejs.
-
Run
$ ./script/dev
Copyright [2022] Carry Technologies, Inc. dba Hightouch
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.