CLI docs

The CLI wraps the same API used by the frontend and downstream agents. It stays shallow so the transport stays obvious.

Public base URL: https://researcher.now.


Local use

pnpm cli ... or pnpm exec tsx src/cli.ts ....


Environment

AUTO_RESEARCH_BASE_URL
Use https://researcher.now for remote access; local runs can point at a dev server.
AUTO_RESEARCH_TOKEN
Required bearer token for every authenticated API call.

Commands

auto-research health
Checks the service.
auto-research pack create ...
Creates a new research pack.
auto-research pack get <id>
Fetches pack and job state.
auto-research pack sources <id>
Lists normalized sources.
auto-research pack context <id>
Prints the agent context payload.
auto-research pack eval <id>
Stores an evaluation record.
auto-research library list
Lists completed packs in the library.
auto-research library get <id>
Fetches a single library entry.
auto-research playbook list
Lists registered playbooks.
auto-research playbook get <id>
Fetches a single playbook.

Example

export AUTO_RESEARCH_BASE_URL="https://researcher.now"
export AUTO_RESEARCH_TOKEN="shared-secret"

pnpm cli pack create \
  --org-id 00000000-0000-0000-0000-000000000000 \
  --requested-by research-auto \
  --topic "popular chocolate chip cookie recipes" \
  --mode collection \
  --playbook cookie_recipe_corpus \
  --depth wide

Fetch context

pnpm cli pack context <pack-id>

This returns the token-budgeted bundle that downstream agents should consume instead of scraping the raw pack tables directly.


Library

pnpm cli library list --limit 20

pnpm cli library get <pack-id>

Playbooks

pnpm cli playbook list

pnpm cli playbook get cookie_recipe_corpus