feynman README

The project's README from github.com/Companion-Inc/feynman. As one markdown file: README.md.

Feynman CLI

The open source AI research agent.

Docs License Ask DeepWiki

Install

macOS / Linux:

curl -fsSL https://feynman.is/install | bash

Windows (PowerShell):

irm https://feynman.is/install.ps1 | iex

Or with npm and Node.js 22.22 or newer: npm install -g @companion-ai/feynman.

Then sign in to a model provider:

feynman setup

The installation guide covers pinned versions, uninstalling, and the skills-only bundle for Codex and OpenCode. The setup guide covers local models and editors such as Zed.

Use

feynman "what do we know about scaling laws"
feynman lit "RLHF alternatives"
feynman deepresearch "mechanistic interpretability"
Workflow What it does
/deepresearch <topic> Planned investigation with parallel researchers and citation checks
/lit <topic or lab> Literature review: consensus, disagreements, open questions
/review <paper or draft> Critique with severity levels and a revision plan
/audit <paper> Paper claims compared with its public code
/replicate <paper> Replication plan; runs only after you choose an environment
/recipe <task> Ranked ML training recipes with datasets and code
/compare <topic> Source comparison matrix
/draft <topic> Paper-style draft from research findings
/autoresearch <idea> Bounded experiment loop against a benchmark
/summarize <source> Summary of a paper, repository, or PDF

Results are saved to outputs/ (drafts to papers/). /lit, /deepresearch, and /recipe also write a provenance file listing the sources used and what was verified.

Sources

Feynman searches alphaXiv, Semantic Scholar, OpenAlex, arXiv, PubMed, Europe PMC, bioRxiv, medRxiv, Crossref, the web, and Hugging Face, and reads local PDFs and documents. Free OPENALEX_API_KEY and SEMANTIC_SCHOLAR_API_KEY keys avoid the shared rate limits. It runs on stock Pi with four research agents: researcher, verifier, reviewer, and writer.

Telemetry

Feynman sends anonymous usage data to PostHog: commands, workflows, tools, models, token counts, and errors with their messages and stack traces (your home folder shown as ~). It never sends prompts, model output, paper content, or tool arguments. Turn it off with FEYNMAN_TELEMETRY=off. What is sent

Contributing

git clone https://github.com/Companion-Inc/feynman.git
cd feynman
npm install
npm test

See CONTRIBUTING.md.

Docs · Release notes · MIT License

feynman (Companion-Inc/feynman)

drug-discovery
Searching Database…

What is this?An open source AI research agent: a terminal app that searches papers, runs literature reviews and deep-research workflows, and links every claim back to its sources.
Is it a terminal tool or does it have a graphical interface?Both. It runs as an interactive terminal REPL where you type requests or slash commands, and feynman serve launches a local science workbench with project/session navigation, notebooks and in-app chat.
Do I need Node.js or an API key to run it?The standalone installer bundles Node, so nothing extra; the npm route needs a local Node.js (>=22.22, <26). No fixed key: point it at local LM Studio, Ollama, LiteLLM or vLLM, or run feynman model login for hosted providers.
Can I trust its claims?Outputs are source-grounded: every claim links to papers, docs or repos by direct URL, and feynman rank scores papers with transparent evidence for citations, methods, reproducibility and provenance.
What are the four built-in research agents?Researcher gathers evidence across papers, web, repos and docs; Reviewer gives severity-graded critique; Writer turns research notes into structured drafts; Verifier checks inline citations, verifies source URLs and cleans up dead links. Workflow prompts invoke them when a task benefits from decomposition.
What is Feynman Bio Tools?A Feynman-owned open science connector catalog: OpenAlex and arXiv workflows, PubMed metadata and PMC full text, bioRxiv/medRxiv preprints, ClinicalTrials.gov trials, FDA labels, ChEMBL and PubChem chemistry, Ensembl and UniProt genomics, pathways, GWAS and dozens more life-science sources.
What can I open inside the serve workbench?Built-in previews for reports, PDFs, images, audio, video, XLSX workbooks, Jupyter notebooks, LaTeX, sequences and alignments, chemistry sketches (KET/RXN/CDXML/CXSMILES), structures, trees and tensors — plus notebooks, compute targets, cloud export and session history.
Size
26.2 MB
Stars
10K
Age
7mo
Commits · 90 Days