CLI overview - Hellotracks developer docs

ht, the Hellotracks command line, runs Hellotracks from a shell, a CI runner or a coding agent: jobs, routes, people, places, timesheets, forms, alerts, reports, ETA pages, maps, webhooks and API keys. It talks to the REST API and nothing else.

ht jobs sync --file work-orders.csv --upsert-by externalId --dry-run
ht routing optimize --account alice@example.com --date today --solve
ht reports run timesheet --period lastWeek --format xlsx

Install

macOS and Linux, arm64 and x64:

curl -fsSL https://cli.hellotracks.org/install.sh | bash

The installer puts ht in ~/.local/bin with its own Node.js runtime and checks the download’s SHA-256 first. ht update installs a newer release. New to Hellotracks? Create a company from the terminal. A 6-digit code sent to your email proves the address; no password is needed, and the API key is stored for you:

ht signup --email sam@acme.com --name "Sam Lee" --company "Acme Plumbing" \
  --address "1 Ferry Building, San Francisco" --accept-terms
ht signup --code 482913

Already have an account? Sign in with an emailed code, or paste an API key from the dashboard:

ht auth login --email sam@acme.com
ht auth whoami

On macOS the key is kept in the Keychain; on Linux in a file only you can read.

What it does

Command	For
`ht jobs`	List, create, update, archive, import, export and sync jobs
`ht routing optimize`	Put a member’s day in the best order
`ht members`, `ht places`	People and places, including `members locate` for last positions
`ht timesheets`	Clock-in and clock-out entries
`ht reports`	Run, preview, save and schedule reports
`ht forms`	Form templates, submissions and attachments
`ht alerts`	Alert rules and the alerts they raised
`ht eta`	Live arrival pages for the people a job is for
`ht maps`	Map snapshots and share links
`ht webhooks`, `ht apikeys`, `ht company`	Integration settings
`ht skills install`	Teach Codex and Claude Code how to use `ht`

Every command explains itself: ht <command> --help. See the command reference and automation recipes.

For scripts and agents

ht commands --json lists every command with its arguments and options.
--json prints the API’s own objects. Errors are JSON on stderr too, with stable exit codes.
--dry-run shows what import and sync would change; --no-input never prompts.

AI agents: see For AI agents.

​Install

​Sign up or sign in

​What it does

​For scripts and agents

Install

Sign up or sign in

What it does

For scripts and agents