Command-line client for Ysaere — multi-agent research swarms for deal teams. Script the loop: balance, run, wait, report, verify.
Every report ships with a Trust Receipt: a signed record with a public verify link.
A receipt attests that a report is unaltered and traces to its sources. It does not attest that every claim is fact.
npm install -g @ysaere/cliRequires Node 20+.
export YSAERE_API_KEY=ysa_prod_YOUR_KEY
ysaere balance
ysaere run angel "Acme Robotics" --domain acme.example
ysaere wait <run_id>
ysaere report <run_id> --format md
ysaere verify <run_id>Get a key at app.ysaere.com — new accounts start with 150 free credits. No card required.
| Command | What it does |
|---|---|
balance |
Current credit balance |
pricing |
Public offering catalog and credit costs (no key needed) |
run <offering> <target> |
Start a run; prints the run_id |
status <run_id> |
One-shot status check |
wait <run_id> |
Poll until the run finishes |
report <run_id> |
Print the finished report |
verify <run_id> |
Fetch the Trust Receipt / provenance |
agents |
Browse marketplace agents |
| Alias | Credits | Report |
|---|---|---|
classify / entity-classify |
10 | Entity Classify (sync) |
quick-brief / brief |
20 | Quick Brief (sync) |
sourced-brief / evidence-brief |
40 | Sourced Brief (sync) |
vault-search |
5 | Vault Search (sync) |
ci / company / competitive |
100 | Company Intelligence |
market |
150 | Market Intelligence |
angel |
50 | Angel Intelligence |
angel-deep |
90 | Angel Deep |
dd / due-diligence |
200 | Due Diligence |
security |
75 | Security Assessment |
retail |
25 | Retail Insights |
retail-deep |
75 | Retail Insights Deep Dive |
ysaere pricing prints the live catalog — the authoritative source.
Meaningful, so scripts can branch on them:
| Code | Meaning |
|---|---|
0 |
Success |
1 |
Generic error |
2 |
The run itself failed |
3 |
Wait timed out (the run may still be going — poll again) |
4 |
Auth error — bad or missing key |
3 is the one worth special-casing: it means "not finished yet", not "failed". Retrying is correct; re-running is a waste of credits.
| Env var | Default | Notes |
|---|---|---|
YSAERE_API_KEY |
— | Required for everything except pricing |
YSAERE_API_URL |
https://api.ysaere.com |
Must be https:// unless loopback |
YSAERE_ALLOW_SANDBOX |
off | Set to 1 to permit ysa_test_* keys (mock runs, no credits) |
YSAERE_TIMEOUT_MS |
30000 |
Per-request timeout |
YSAERE_ALLOW_INSECURE_BASE_URL |
off | Escape hatch for a local dev server over http:// |
There is deliberately no --api-key flag. The key is read from the environment only, so it never lands in ps output or your shell history.
The CLI refuses to send your key over plain HTTP to a non-loopback host.
Transient failures (429, 5xx, network) retry with exponential backoff, honoring Retry-After. Only GETs are retried — a run POST starts a paid job and is never replayed.
REST (https://api.ysaere.com/v1/openapi.json) · TypeScript SDK (@ysaere/sdk) · MCP server (https://mcp.ysaere.com/mcp) · Builders hub
Ysaere is in beta. Outputs are AI-generated for informational purposes only. They are not investment, legal, tax, accounting, real-estate appraisal, security-assessment, or other professional advice. Trust Receipts attest to the integrity of an output (that it is unaltered), not to the truth or accuracy of any statement. Independently check every factual claim against primary sources before acting.
MIT © Ysaere, Inc.