Feynman CLI

The open source AI research agent.

Docs License

--- ### Installation **macOS / Linux:** ```bash curl -fsSL https://feynman.is/install | bash ``` **Windows (PowerShell):** ```powershell irm https://feynman.is/install.ps1 | iex ``` The one-line installer fetches the latest tagged release. To pin a version, pass it explicitly, for example `curl -fsSL https://feynman.is/install | bash -s -- 0.2.17`. If you install via `pnpm` or `bun` instead of the standalone bundle, Feynman requires Node.js `20.19.0` or newer. Local models are supported through the custom-provider flow. For Ollama, run `feynman setup`, choose `Custom provider (baseUrl + API key)`, use `openai-completions`, and point it at `http://localhost:11434/v1`. ### Skills Only If you want just the research skills without the full terminal app: **macOS / Linux:** ```bash curl -fsSL https://feynman.is/install-skills | bash ``` **Windows (PowerShell):** ```powershell irm https://feynman.is/install-skills.ps1 | iex ``` That installs the skill library into `~/.codex/skills/feynman`. For a repo-local install instead: **macOS / Linux:** ```bash curl -fsSL https://feynman.is/install-skills | bash -s -- --repo ``` **Windows (PowerShell):** ```powershell & ([scriptblock]::Create((irm https://feynman.is/install-skills.ps1))) -Scope Repo ``` That installs into `.agents/skills/feynman` under the current repository. These installers download the bundled `skills/` and `prompts/` trees plus the repo guidance files referenced by those skills. They do not install the Feynman terminal, bundled Node runtime, auth storage, or Pi packages. --- ### What you type → what happens ``` $ feynman "what do we know about scaling laws" → Searches papers and web, produces a cited research brief $ feynman deepresearch "mechanistic interpretability" → Multi-agent investigation with parallel researchers, synthesis, verification $ feynman lit "RLHF alternatives" → Literature review with consensus, disagreements, open questions $ feynman audit 2401.12345 → Compares paper claims against the public codebase $ feynman replicate "chain-of-thought improves math" → Replicates experiments on local or cloud GPUs ``` --- ### Workflows Ask naturally or use slash commands as shortcuts. | Command | What it does | | --- | --- | | `/deepresearch ` | Source-heavy multi-agent investigation | | `/lit ` | Literature review from paper search and primary sources | | `/review ` | Simulated peer review with severity and revision plan | | `/audit ` | Paper vs. codebase mismatch audit | | `/replicate ` | Replicate experiments on local or cloud GPUs | | `/compare ` | Source comparison matrix | | `/draft ` | Paper-style draft from research findings | | `/autoresearch ` | Autonomous experiment loop | | `/watch ` | Recurring research watch | | `/outputs` | Browse all research artifacts | --- ### Agents Four bundled research agents, dispatched automatically. - **Researcher** — gather evidence across papers, web, repos, docs - **Reviewer** — simulated peer review with severity-graded feedback - **Writer** — structured drafts from research notes - **Verifier** — inline citations, source URL verification, dead link cleanup --- ### Skills & Tools - **[AlphaXiv](https://www.alphaxiv.org/)** — paper search, Q&A, code reading, annotations (via `alpha` CLI) - **Docker** — isolated container execution for safe experiments on your machine - **Web search** — Gemini or Perplexity, zero-config default - **Session search** — indexed recall across prior research sessions - **Preview** — browser and PDF export of generated artifacts - **Modal** — serverless GPU compute for burst training and inference - **RunPod** — persistent GPU pods with SSH access for long-running experiments --- ### How it works Built on [Pi](https://github.com/badlogic/pi-mono) for the agent runtime, [alphaXiv](https://www.alphaxiv.org/) for paper search and analysis, and CLI tools for compute and execution. Capabilities are delivered as [Pi skills](https://github.com/badlogic/pi-skills) — Markdown instruction files synced to `~/.feynman/agent/skills/` on startup. Every output is source-grounded — claims link to papers, docs, or repos with direct URLs. --- ### Contributing See [CONTRIBUTING.md](CONTRIBUTING.md) for the full contributor guide. ```bash git clone https://github.com/getcompanion-ai/feynman.git cd feynman nvm use || nvm install npm install npm test npm run typecheck npm run build ``` [Docs](https://feynman.is/docs) · [MIT License](LICENSE)