Skip to main content

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.

Feynman is built on the Pi runtime and uses curated Pi packages for its capabilities. Core packages are installed by default to keep first-run setup fast. Optional packages can be added on demand with feynman packages install.

Core packages

These packages are installed automatically with every Feynman installation. They provide the foundation for all research workflows and the REPL experience.
PackagePurpose
@companion-ai/alpha-hubalphaXiv integration for paper search, discussion threads, and citation metadata
pi-subagentsParallel agent spawning for literature gathering and task decomposition. Powers all multi-agent research workflows
pi-btwFast side-thread conversations without interrupting the main research run
pi-docparserParse PDFs, Office documents, spreadsheets, and images for content extraction
pi-web-accessWeb browsing, GitHub access, PDF fetching, and media retrieval
pi-markdown-previewRender Markdown and LaTeX-heavy research documents as polished HTML/PDF
@walterra/pi-chartsGenerate charts and quantitative visualizations from data
pi-mermaidRender Mermaid diagrams in the terminal UI
@aliou/pi-processesManage long-running experiments, background tasks, and log tailing. Powers /ps
pi-zoteroIntegration with Zotero for citation library management
@kaiserlich-dev/pi-session-searchIndexed session recall with summarize and resume UI. Powers /search
pi-schedule-promptSchedule recurring and deferred research jobs. Powers the /watch workflow
@samfp/pi-memoryAutomatic preference and correction memory across sessions
@tmustier/pi-ralph-wiggumLong-running autonomous agent loops. Powers /autoresearch
Core packages are updated together when you run feynman update. You do not need to manage them individually.

Optional packages

Install these on demand with feynman packages install <preset>. They extend Feynman with capabilities that not every user needs.
PresetPackagePurpose
generative-uipi-generative-uiInteractive Glimpse UI widgets for rich, HTML-style output in the REPL
The generative-ui preset can also be installed using the alias ui: feynman packages install ui.

Managing packages

List packages

Show all available packages and their install status:
feynman packages list
This displays core packages (always installed) and optional presets with an (installed) marker for any that are already active.

Install optional packages

feynman packages install generative-ui

Update packages

Update all installed packages to their latest versions:
feynman update
Update a specific package by name:
feynman update pi-subagents
feynman update pi-web-access
Running feynman update without arguments updates everything. Updates are safe and preserve your configuration and session data.

What packages enable

The pi-subagents package enables Feynman to spawn and coordinate parallel research agents. Every multi-agent workflow — /deepresearch, /lit, /review, /audit, /replicate, /compare, and /draft — depends on this package to delegate work across researcher, reviewer, writer, and verifier subagents simultaneously.
pi-web-access gives Feynman access to the web, GitHub repositories, and arbitrary PDFs during research. @companion-ai/alpha-hub adds alphaXiv-specific paper search, discussion thread access, and citation metadata. Together they form the primary source-gathering layer for all research workflows.
pi-docparser lets Feynman ingest PDFs, Word documents, spreadsheets, and images as input to research tasks. Drop a PDF into your working directory and Feynman can read and cite it.
pi-markdown-preview renders research artifacts — including LaTeX equations — as HTML or PDF directly from the REPL via the /preview command. Requires pandoc, which can be installed via feynman --setup-preview.
Automatically records your preferences and corrections across sessions. If you consistently prefer a particular output format or correct the same terminology, memory surfaces those preferences in future sessions.
Provides the /ps command for inspecting active background tasks, running experiments, and scheduled follow-ups. Used by /autoresearch and /watch to manage long-running work.
Powers the /watch workflow by creating durable scheduled or recurring prompts. When you set a watch on a topic, pi-schedule-prompt ensures follow-up sweeps happen at the configured frequency — not just when you remember to ask.
Powers the /autoresearch command. Manages the iteration state, benchmark command execution, experiment logging, and keep/revert decisions across many optimization cycles.
Adds interactive Glimpse UI widgets to REPL output. Useful when you want richer, HTML-style interactive displays rather than plain Markdown. Install with feynman packages install generative-ui.