This guide assumes you have already installed Feynman and completed feynman setup. If not, start there first.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/getcompanion-ai/feynman/llms.txt
Use this file to discover all available pages before exploring further.
Launch the REPL
Start an interactive session by running Feynman with no arguments:You are dropped into a conversational REPL where you can ask research questions, run workflows, and interact with agents in natural language. Type your question and press Enter.
Try a one-shot prompt
For a quick answer without entering the REPL, pass a prompt directly on the command line:Feynman processes the prompt, prints the response, and exits. This is useful for scripting or piping output into other tools.
Run deep research
Deep research is the flagship workflow. It dispatches multiple agents to search, read, cross-reference, and synthesize information from academic papers and the web.From the REPL:Or run it directly from the command line without entering the REPL:The agents produce a structured research report with citations, key findings, and open questions. The full report is saved to your
outputs/ directory.Explore slash commands
Type Key workflows you can invoke:
/help inside the REPL to see all available slash commands grouped by category. Each command maps to a workflow or utility:| Command | What it does |
|---|---|
/deepresearch <topic> | Multi-agent investigation with parallel researchers |
/lit <topic> | Literature review from paper search and primary sources |
/review <artifact> | Simulated peer review with severity and revision plan |
/audit <item> | Paper vs. codebase mismatch audit |
/replicate <paper> | Replicate experiments on local or cloud GPUs |
/compare <topic> | Source comparison matrix |
/draft <topic> | Paper-style draft from research findings |
/watch <topic> | Recurring research watch |
/outputs | Browse all research artifacts |
Find your outputs
Feynman writes research artifacts to your working directory using a slug-based naming scheme. After a research run, check these directories:
Use
| Directory | Contents |
|---|---|
outputs/ | Research reports, briefs, and comparison matrices |
papers/ | Paper-style drafts |
notes/ | Session logs and intermediate research notes |
/outputs in the REPL to browse all artifacts interactively.What’s next
CLI commands reference
Complete reference for all Feynman CLI commands, flags, and subcommands.
Slash commands reference
Full list of REPL slash commands and their arguments.
Setup
Change your model provider, configure API keys, or connect to alphaXiv.
Introduction
Learn about the four research subagents and the full workflow catalog.