Skip to content

Primr Documentation

Company URL → sourced strategic brief. Local-first CLI and agent tooling for discovery, account planning, diligence, and strategy work, with structured collection, confidence labels, and durable artifacts, not a free-form chat essay.

Illustrative primr CLI session for ExampleCo: dry-run cost estimate and completed report artifacts

Illustrative demo with placeholder company data. Not a live capture of a real target. Regenerate via CONTRIBUTING.md.

Start here Link
Install and shortest path Root README · Installation
Agent-host operation (Primr Zero by default) Operator guide · Agent Integration · Zero-cost
Modes, costs, cost gate Run modes
Changing Primr source AGENTS.md · Contributing

The root README is a front door only. Operator detail lives in the guides below (Diataxis: learning, doing, looking up, understanding).

Index currency: reviewed against primr 1.39.36 on 2026-11-16. The Updated column is each document's last substantive revision (git last-commit date). tests/test_docs_index.py fails CI if a doc under docs/ is missing from this map or an index link does not resolve, so the map and the tree cannot silently drift apart.

Getting started (tutorials)

Document Description Updated
INSTALLATION Install, upgrade, and troubleshoot Primr or prepare a source checkout 2026-10-20
ZERO_COST Run keyless collection and finish a sourced dossier with an existing agent plan 2026-10-11
API_KEYS API key setup, validation (primr keys test), security, and troubleshooting 2026-10-12
OPENROUTER Optional paid gateway, explicit opt-in, expanded model catalog, role overrides, per-run ceilings, and custom models 2026-10-13
CONFIG First-run configuration and the full settings reference 2026-10-11
RUN_MODES Run modes, costs, budget readiness, strategy selection, outputs, and zero-cost rendering 2026-10-12
AZURE_QUICKSTART Stand up the team/org Azure deployment end to end 2026-07-18

How-to guides (task-oriented)

Document Description Updated
BATCH Run primr across many companies from a CSV 2026-07-18
RECOVERY Resume after a crash, reboot, or interrupted run 2026-08-14
IMPROVE Improve and refine an existing report (primr improve / refine) 2026-08-13
SKILL_PACK primr skills end to end: planning, curation, artifacts, CLI/MCP 2026-08-14
EVAL Evaluate and compare models with the eval harness 2026-10-13
MODEL_ONBOARDING Register and validate a new model 2026-08-13
AGENT_INTEGRATION Operate Primr from MCP, A2A, skills, and agent hosts 2026-09-13
OPENCLAW OpenClaw integration and governed workflows 2026-08-13
COPILOT_COWORK_GUIDE Sideload a skill pack into Microsoft 365 Copilot Cowork 2026-07-21
COPILOT_STUDIO_GUIDE Use primr from Copilot Studio 2026-08-13
FOUNDRY_AGENT_GUIDE Use primr from a Microsoft Foundry agent 2026-07-21
CLOUD_DEPLOYMENT Serverless deployment on AWS, Azure, and GCP 2026-08-13
SECURITY_OPS Key rotation, audit logs, operational security 2026-08-13

Reference (look-up)

Document Description Updated
API MCP server and A2A protocol, programmatic usage 2026-08-13
Job Status Versioned CLI, MCP, A2A, and API lifecycle contract 2026-08-05
STRATEGY_PORTFOLIO YAML-defined long-form strategy documents and selection 2026-08-30
NEXT_STEPS One executable release card, dependency gates, and version update protocol 2026-10-20
ROADMAP_REVIEW Current-source evidence for priorities, MCP and Agent Plugins compatibility, evaluation, and development guidance 2026-09-13
CHANGELOG Version history 2026-10-20
MIGRATION Error-hierarchy migration notes 2026-02-02
EVAL_V1_24_0 Historical decision record: the v1.24.0 cross-provider eval plan 2026-10-11
ROADMAP Release dependencies, long-range gates, and implementation ledger 2026-09-02

Explanation (understanding why)

Document Description Updated
Company Analyst Product Contract Canonical product, long-form artifact, free-first economics, evaluation, and release contract 2026-08-30
ARCHITECTURE System design and the 9-tier scraping engine 2026-10-20
ARTIFACTS The research-vs-shipping artifact pipeline and ship-time gates 2026-09-01
INTERNALS Core algorithms and prompt strategy 2026-08-13
STATE_MACHINES Tier escalation and job lifecycle 2026-02-02
CONCURRENCY Threading and concurrency model 2026-08-13
SECURITY Security policy and the scoped AI/agent threat model 2026-10-20
design/ Per-workstream design docs and decision audits —

Contributing

Document Description Updated
CONTRIBUTING Dev environment setup and the contribution workflow 2026-10-20
AGENTS.md The development contract: seams, constraints, verification gates (CLAUDE.md imports it) —