diff --git a/README.md b/README.md index d265d90..63b09d1 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,59 @@ -# Feynman +
+
+
+
+
The open source AI research agent.
+ -The open source AI research agent +--- + +### Installation ```bash curl -fsSL https://feynman.is/install | bash ``` ```powershell +# Windows irm https://feynman.is/install.ps1 | iex ``` -Or install the npm fallback: - ```bash +# npm fallback npm install -g @companion-ai/feynman ``` -```bash -feynman setup -feynman +Then run `feynman setup` to configure your model and get started. + +--- + +### 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" +→ Asks where to run, then builds a replication plan ``` -Feynman works directly inside your folder or repo. For long-running work, keep the stable repo contract in `AGENTS.md`, the current task brief in `outputs/.plans/`, and the chronological lab notebook in `CHANGELOG.md`. - --- -## What you type → what happens - -| Prompt | Result | -| --- | --- | -| `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"` | Asks where to run, then builds a replication plan | -| `feynman "summarize this PDF" --prompt paper.pdf` | One-shot mode, no REPL | - ---- - -## Workflows +### Workflows Ask naturally or use slash commands as shortcuts. @@ -56,9 +71,9 @@ Ask naturally or use slash commands as shortcuts. --- -## Agents +### Agents -Four bundled research agents, dispatched automatically or via subagent commands. +Four bundled research agents, dispatched automatically. - **Researcher** — gather evidence across papers, web, repos, docs - **Reviewer** — simulated peer review with severity-graded feedback @@ -67,42 +82,23 @@ Four bundled research agents, dispatched automatically or via subagent commands. --- -## Tools +### Tools - **[AlphaXiv](https://www.alphaxiv.org/)** — paper search, Q&A, code reading, persistent annotations - **Docker** — isolated container execution for safe experiments on your machine -- **Web search** — Gemini or Perplexity, zero-config default via signed-in Chromium -- **Session search** — optional indexed recall across prior research sessions +- **Web search** — Gemini or Perplexity, zero-config default +- **Session search** — indexed recall across prior research sessions - **Preview** — browser and PDF export of generated artifacts --- -## CLI +### How it works -```bash -feynman # REPL -feynman setup # guided setup -feynman doctor # diagnose everything -feynman status # current config summary -feynman model login [provider] # model auth -feynman model setInvestigate topics, write papers, run experiments, review research, audit codebases — every output cited and source-grounded
+