Sitelet https://github.com/Companion-Inc/feynman
Skip to content

Latest commit

 

History

708 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

The open source AI research agent.

Topics

Resources

Contributing

Stars

9.9k stars

Watchers

33 watching

Forks

Releases

Packages

Contributors

Languages