Command Line · Local Preview

Research Workbench · Command Line

Review the local-development command surface for quotes, financials, peers, research outputs, and satellite-industry signals. This public documentation is static and connects no provider, model, or credential.
$ research-os quote NVDA
Zero runtime dependencies No API key Node.js ≥ 18 MIT research-os@0.1.0

⚡ Local use Connects to the local preview API

Run a quote request
$ research-os quote NVDA
The command reads from the configured local service and prints the response.
Override the local endpoint
$ IR_API_BASE=http://127.0.0.1:8000 research-os quote 0700.HK
Use an explicit endpoint when the default local service is running elsewhere.

🔤 Symbol formats Common market formats map to one internal identifier

InputResolved asNotes
NVDAUS:NVDAUS equity, letters only
600519SH:600519A-share; a leading 6 maps to Shanghai
300750SZ:300750A-share; a leading 0 or 3 maps to Shenzhen
0700.HKHK:00700Hong Kong; padded to five digits
600519.SSSH:600519Yahoo-style suffix
US:NVDAUS:NVDAInternal identifier supplied directly
Search first when you do not know the symbol
$ research-os search CATL

Symbol      Name   Market
SZ:300750  CATL   SZ
HK:03750   CATL   HK

📈 Market data and fundamentals

quote <symbol>Latest quote, change, and shares outstanding
search <query>Fuzzy company-name and symbol search
news <symbol>Company news; add --zh for Chinese-title translation
financials <symbol>Financial metrics with optional cross-source validation
history <symbol>Annual or quarterly financial history
peers <symbol>Peer-company PE, PB, and PS
profile <symbol>Company profile
bars <symbol>Daily price bars
indicesMajor market indices
industriesAvailable industry research sets
industry <key>Constituents, aggregate financials, and value-chain context
pulse [key]Industry-move alerts; defaults to satellite internet

🧠 Research Optional local narrative layer with a required disclaimer

ask <question>Conversational research
thesis <symbol>Bull case, bear case, and moat assessment
compare <A> <B>Like-for-like comparison across symbols
$ research-os ask "Where is Nvidia's moat?"
$ research-os compare NVDA AMD

🛰 Satellite internet Uses the same local data as the dashboard

eventsIndustry event stream
alertsRisk alerts and falsification triggers
weeklyWeekly decision report in Markdown
companiesValue-chain company cards
thesis-stateVersioned scores for each research theme
sourcesData-source ledger

⚙️ Global options and pipelines

--json, -jPrint raw JSON for tools such as jq
--api <url>Override the market-data API URL (or set IR_API_BASE)
--agent <url>Override the industry-agent API URL (or set IR_AGENT_BASE)
--timeout <ms>Request timeout: 30 seconds by default; 180 seconds for research commands
--help, -hShow help
--version, -vShow version
$ research-os quote 0700.HK --json | jq .price
$ research-os peers NVDA --json | jq -r '.rows[] | "\(.name)\t\(.pe)"'
$ research-os weekly > weekly.md
Exit codes: 0 success · 1 request failed (details go to stderr; no partial data is emitted) · 2 invalid usage.

📐 Data boundaries Read these limits before using the output

  • Numbers come from data tools, not the CLI renderer. The command line maps parameters and formats the exact values returned by the local API.
  • Missing data degrades explicitly. Unavailable fields render as dashes; they are never replaced with zero or invented.
  • Search coverage differs by market. A-share Chinese names support broad fuzzy search; Hong Kong and US coverage is strongest for English names, pinyin, and symbols.
  • Narrative generation is an optional local-development capability. It is not connected on this public page; where enabled locally, figures still come from deterministic calculations and every output includes a disclaimer.
  • No alert means no rule fired. An empty response is a valid result, not necessarily an outage.
  • The preview does not handle credentials. It does not accept, read, store, or send authorization tokens. It sends only the query you enter to the configured local service and includes no telemetry.
Outputs are for research and educational purposes only and are not investment advice. Verify the evidence and make decisions independently.