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


Installation

macOS / Linux:

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

Windows (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.35.

The installer downloads a standalone native bundle with its own pinned Node.js runtime and verifies the release SHA-256 before replacing an existing installation.

To upgrade the standalone app later, rerun the installer. feynman update only refreshes installed Pi packages inside Feynman's environment; it does not replace the standalone runtime bundle itself.

To uninstall the standalone app, remove the launcher and runtime bundle, then optionally remove ~/.feynman if you also want to delete settings, workbench app state, sessions, and installed package state. If you also want to delete alphaXiv login state, remove ~/.ahub. See the installation guide for platform-specific paths.

npm alternative (uses your local Node.js runtime):

npm install -g @advaitpaliwal/feynman

To update an npm installation, run npm install -g @advaitpaliwal/feynman@latest.

If you installed the old scoped package, migrate once:

npm uninstall -g @companion-ai/feynman
npm install -g @advaitpaliwal/feynman

The command remains feynman; the native install commands above are unchanged. See the installation guide for Node.js requirements and uninstall instructions.

Local models are supported through the setup flow. For LM Studio, run feynman setup, choose LM Studio, and keep the default http://localhost:1234/v1 unless you changed the server port. For LiteLLM, choose LiteLLM Proxy and keep the default http://localhost:4000/v1. For Ollama or vLLM, choose Custom provider (baseUrl + API key), use openai-completions, and point it at the local /v1 endpoint.

To authenticate another hosted provider, run feynman model login <provider>. GitHub Copilot sign-in retries model discovery once when GitHub rate-limits the request. OpenRouter login opens an OAuth page and listens for a local callback; over SSH or in another headless environment, paste the browser's final redirect URL or authorization code into Feynman's prompt, or set OPENROUTER_API_KEY before launch to use API-key authentication without OAuth.

Skills Only

If you want just the research skills without the full terminal app:

macOS / Linux:

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

Windows (PowerShell):

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

That installs the skill library into ~/.codex/skills/feynman for Codex. You can also name the Codex target explicitly:

macOS / Linux:

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

Windows (PowerShell):

& ([scriptblock]::Create((irm https://feynman.is/install-skills.ps1))) -Scope Codex

For a repo-local Claude/agent install instead:

macOS / Linux:

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

Windows (PowerShell):

& ([scriptblock]::Create((irm https://feynman.is/install-skills.ps1))) -Scope Repo

That installs into .agents/skills/feynman under the current repository.

For an OpenCode project-local install instead:

macOS / Linux:

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

Windows (PowerShell):

& ([scriptblock]::Create((irm https://feynman.is/install-skills.ps1))) -Scope OpenCode

That installs into .opencode/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 -- "- summarize the strongest evidence first"
→ Preserves a research prompt that begins with a dash instead of parsing it as a CLI option

$ feynman --prompt="- summarize the strongest evidence first"
→ Runs a dash-leading research prompt once and exits

$ feynman deepresearch "mechanistic interpretability"
→ Multi-agent investigation with parallel researchers, synthesis, verification

$ feynman lit "RLHF alternatives"
→ Literature review with consensus, disagreements, open questions, and lab/PI corpus mode when the input names a research group

$ feynman rank "mechanistic interpretability sparse autoencoders"
→ Decides what to read first with citation, method, reproducibility, and provenance evidence

$ feynman rank "mechanistic interpretability sparse autoencoders" --expand-citations 2
→ Adds cited and citing papers to the local citation graph before scoring graph prestige

$ feynman rank "mechanistic interpretability sparse autoencoders" --full-text-top 3
→ Adds section-aware full-text evidence and checklist rubric answers before rescoring

$ feynman rank "mechanistic interpretability sparse autoencoders" --critique-top 5
→ Adds research-critique strengths, concerns, and follow-up questions grounded in score evidence

$ feynman rank "mechanistic interpretability sparse autoencoders" --synthesize
→ Writes an auditable model synthesis and names the selected model plus whether it was recommended or explicitly requested

$ feynman paper 10.7717/peerj.4375 --fetch-full-text
→ Resolves legal full-text access candidates for one paper and fetches source-specific text when available

$ feynman serve
→ Opens the standalone science workbench with projects, Pi chat, Feynman Bio Tools, notebooks, compute, artifact previews, provenance, settings, skills, and onboarding context

$ feynman serve --no-auth
→ Opens the same local workbench at a plain localhost URL for trusted local testing

$ feynman audit 2401.12345
→ Compares paper claims against the public codebase

$ feynman replicate "chain-of-thought improves math"
→ Plans replication checks and runs them only after an explicit environment choice

$ feynman recipe "fine-tune a small model for math reasoning"
→ Finds ranked, implementable ML training recipes from papers, datasets, docs, and code

Workflows

Ask naturally or use slash commands as shortcuts.

Command What it does
feynman rank <topic> PaperRank scoring for deciding what to read first, with transparent evidence for citations, methods, reproducibility, and provenance
feynman paper <id-or-title> Paper access resolver for one DOI, arXiv ID, OpenAlex ID, PMID, PMCID, or title, with OpenAlex, arXiv/alphaXiv, DOI, and Europe PMC candidates plus optional source-specific text fetching
feynman serve Standalone science workbench with project/session navigation, project metadata, in-app Pi chat, optional --no-auth plain localhost mode, Feynman Bio Tools, Ketcher chemistry sketch artifacts, notebooks, compute, Files host inventory for local, SSH/BYOC, and cloud-backed artifact contexts, audio/video/spreadsheet/notebook/LaTeX/science artifact previews including element-level HTML report annotations and KET/RXN/CDXML/CXSMILES chemistry sketches, artifact Notes and note preview modals, Cloud storage credential modal, Cloud export target/destination modal, frame records, frame message rows, frame backfill health records, lineage, provenance, settings, org-scoped app-data workbench state under ~/.feynman/orgs/<org_uuid>/workbench, an org-level feynman-workbench.db mirror with physical tables for the full reference-shaped workbench ledger coverage map including compute egress/Modal environment fields and Feynman-owned connector ledgers, watch routine state, skill source/license state, setup decision state, review feedback state, compute poller lease state, redacted credential state, onboarding intent context, verification files, and CHANGELOG.md lab-notebook entries
/deepresearch <topic> Source-heavy multi-agent investigation
/lit <topic-or-lab> Literature review from paper search and primary sources; lab/PI inputs map publication trajectories and originality-ranked papers
/review <artifact> Research review with severity and revision plan
/audit <item> Paper vs. codebase mismatch audit
/replicate <paper> Plan replication checks; execute only after choosing an environment
/recipe <task-or-paper> Ranked ML training recipes with dataset, method, code, and verification status
/compare <topic> Source comparison matrix
/draft <topic> Paper-style draft from research findings
/autoresearch <idea> Bounded experiment loop with benchmark evidence
/watch <topic> Research watch baseline with optional scheduled follow-up
/btw <question> Side conversation while the main research agent is busy, with optional handoff back into the main thread
/thinking [level] View or set model reasoning effort (off through max, model permitting) without leaving the REPL
/outputs Browse all research artifacts

Agents

Four bundled research agents, invoked by workflow prompts when decomposition helps.


Skills & Tools


How it works

Built on Pi for the agent runtime, alphaXiv for paper search and analysis, and CLI tools for compute and execution. Runtime resources follow Pi's documented package model for packages, extensions, and skills. Hugging Face inspection uses the public Hub API endpoints and HF_TOKEN / HUGGINGFACE_HUB_TOKEN environment variables documented by huggingface_hub. The ML recipe workflow was informed by the open-source Hugging Face ml-intern research-agent repo, but is implemented as native Feynman prompts, skills, and read-only tools. Research outputs are source-grounded — research claims link to papers, docs, or repos with direct URLs.


Star History

Star History Chart

The bundled research runtime is updated as a coordinated set, including Pi, Alpha Hub's alpha-mcp, document parsing, web research, and subagents. See the package stack and release notes for versions and upgrade details.

Contributing

See CONTRIBUTING.md for the full contributor guide.

git clone https://github.com/advaitpaliwal/feynman.git
cd feynman
nvm use || nvm install
npm install
npm test
npm run typecheck
npm run build

Docs · Release Notes · MIT License

feynman (Companion-Inc/feynman)

Searching Database…

这是什么?一个开源的 AI 科研代理:这是一款终端应用,能搜索论文、做文献综述和深度研究流程,并把每一条结论都链接回它的来源。
它是终端工具,还是有图形界面?两者都有。它既可以作为交互式终端 REPL 运行,你输入请求或斜杠命令;也可以用 feynman serve 启动一个本地科学工作台,带项目/会话导航、笔记本和应用内聊天。
运行它需要 Node.js 或 API 密钥吗?独立安装包自带 Node,不需要额外装任何东西;走 npm 方式则需要本地安装 Node.js(>=22.22,<26)。没有固定的密钥:可以指向本地的 LM Studio、Ollama、LiteLLM 或 vLLM,也可以运行 feynman model login 使用托管的模型服务。
它的结论可信吗?输出以来源为依据:每条结论都通过直接链接指向论文、文档或代码仓库,而且 feynman rank 会为论文打分,在引用、方法、可复现性和来源可溯方面给出透明的依据。
四个内置的研究代理是什么?Researcher 负责从论文、网页、代码仓库和文档中收集证据;Reviewer 给出按严重程度分级的批评意见;Writer 把研究笔记整理成结构化的文稿;Verifier 检查行内引用、核实来源 URL 并清理失效链接。当一个任务适合拆分处理时,工作流提示会自动调用它们。
Feynman Bio Tools 是什么?这是 Feynman 旗下的开放科学数据源目录:包括 OpenAlex 和 arXiv 工作流、PubMed 元数据和 PMC 全文、bioRxiv/medRxiv 预印本、ClinicalTrials.gov 临床试验、FDA 药品标签、ChEMBL 和 PubChem 化学数据、Ensembl 和 UniProt 基因组数据,以及通路、GWAS 等数十个生命科学数据源。
在 serve 工作台里能打开哪些东西?内置预览支持报告、PDF、图片、音频、视频、XLSX 表格、Jupyter 笔记本、LaTeX、序列与比对结果、化学草图(KET/RXN/CDXML/CXSMILES)、分子结构、树状图和张量——此外还有笔记本、计算目标、云端导出和会话历史。
Size
25.1 MB
Stars
10K
Age
6mo
Commits · 90 Days