amoreg CLI wraps the whole API for terminal use — no install needed with
bunx or npx.
Setup
Commands
Options
npx amoreg … behaves identically. Requests draw from your organisation’s
prepaid balance — see Credits & pricing.Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
The amoreg command-line interface
amoreg CLI wraps the whole API for terminal use — no install needed with
bunx or npx.
export AMOREG_API_KEY=amrg_live_... # dashboard: Organization → API
| Variable | Purpose |
|---|---|
AMOREG_API_KEY | Organisation API key (required) |
AMOREG_API_URL | Override the base URL (default https://app.amoreg.com/api/v1) |
# Hybrid search over policies + enabled jurisdictions
bunx amoreg search "client asset segregation requirements" --jurisdiction fca
# List jurisdictions enabled for your organisation
bunx amoreg jurisdictions
# Credit balance and holds
bunx amoreg balance
# Recent ledger entries
bunx amoreg ledger
# Batch keyword screening (durable workflow, polls until done)
bunx amoreg screen "crypto custody" "operational resilience" -j fca
| Flag | Applies to | Meaning |
|---|---|---|
-j, --jurisdiction <slug> | search, screen | Restrict to a jurisdiction (repeatable) |
-k, --top-k <n> | search, screen | Matches per query (default 5) |
--json | all | Raw JSON output for piping |
npx amoreg … behaves identically. Requests draw from your organisation’s
prepaid balance — see Credits & pricing.