CLI

Use the CLI for local checks, CI jobs, and repeatable scripts. It calls the same Hoist Assets API as your application code.

Auth

CLI calls use a bearer token. Pass it with --token or set HOIST_TOKEN.

export HOIST_TOKEN=hoist_live_or_oauth_token

Use the same token you use for API calls. You do not create a separate CLI credential, and Hoist does not issue CLI API keys.

Commands

Command	Use it for	API route
`hoist health`	Check the API host.	`GET /v1/_health`
`hoist abn lookup <abn>`	Check an ABN.	`GET /v1/abn/{abn}`
`hoist ppsr preview <subject>`	Preview a PPSR search before a paid run.	`POST /v1/ppsr/preview`
`hoist ppsr search <subject>`	Run a PPSR organisation or serial-number search after paid source access is enabled.	`POST /v1/ppsr/search`
`hoist receipts get`	Read logs for completed checks.	`GET /v1/receipts/due-diligence`

Examples

hoist health --base-url https://api.assets.hoistai.com

hoist abn lookup 11695718659 --json

hoist ppsr preview 506066341 \
  --base-url https://api.assets.hoistai.com/v1 \
  --json

hoist ppsr search 123456789 \
  --purpose "counterparty check" \
  --json

The preview command performs a non-billable check. Dispatch commands should be used only after the human or workflow has confirmed the subject and cost.

When to use the CLI

Run checks from CI.
Debug a request before wiring it into an app.
Let a local agent call Hoist through shell commands.
Export logs or records from a script.