CLI

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

Install

Not yet on npm.The Hoist CLI is not published to a package registry yet. For now, build it from source in the Hoist repository. A signed npm release is planned.

Auth

CLI calls use a Hoist API key (prefixed ha_live_). Pass it with --token or set HOIST_API_KEY.

terminal

export HOIST_API_KEY=ha_live_xxxxxxxxxxxxxxxxxxxxxxxx

Use the same API key you use for REST API calls. You do not create a separate CLI credential.

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 receipts get	Read logs for completed checks.	GET /v1/receipts/due-diligence

Examples

terminal

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

hoist abn lookup 11695718659 --json

The PPSR preview and explicit-confirmation mechanics are implemented but not currently customer-accessible. Hoist does not publish runnable PPSR CLI commands while preview and paid search are unavailable. Preview requests fail closed without returning a price or dispatching a register search. Use AFSA direct if you need a paid PPSR search today.

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.