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.

The feynman setup wizard configures your model provider, API keys, alphaXiv authentication, and optional preview dependencies. It runs automatically on first launch when no model is configured, but you can re-run it at any time to change your configuration.

Running setup

feynman setup
feynman setup requires an interactive terminal (a TTY). If you run it in a non-interactive environment such as a CI pipeline or a Docker container, it will print guidance for the equivalent explicit commands instead.
In non-interactive terminals, use the following commands directly:
feynman model login <provider>
feynman model set <provider/model>
feynman alpha login
feynman doctor

Setup flow

1

Select a model provider

The wizard presents a list of supported providers. Use the arrow keys to select your preferred default model. Supported providers include:
  • Anthropic — Claude models (claude-sonnet-4, claude-opus-4, etc.)
  • OpenAI — GPT-4o, o3, and other OpenAI models
  • Google — Gemini models
  • OpenRouter — Access to a wide range of models through a single API key
  • xAI — Grok models
  • Groq — Fast inference for open models
  • Mistral — Mistral and Codestral models
  • Cerebras — High-speed inference
  • HuggingFace — HuggingFace-hosted models
  • GitHub Copilot — Models via the GitHub Copilot API
  • Azure OpenAI — Azure-hosted OpenAI deployments
The selected model becomes the default for all sessions. You can override it per-session with --model or change it later.
2

Authenticate with your provider

Depending on your chosen provider, setup prompts you for an API key or walks you through an OAuth login flow. For API key providers, paste your key when prompted. Keys are stored in ~/.feynman/auth.json and are never sent anywhere except the provider’s API endpoint.
3

Connect to alphaXiv

alphaXiv provides paper search, Q&A, code reading, and annotation capabilities. If you are not already logged in, setup opens a browser window to complete the alphaXiv sign-in flow. Your session is stored in ~/.feynman/.You can authenticate separately at any time:
feynman alpha login
To check your alphaXiv auth status:
feynman alpha status
4

Install preview dependencies

Setup checks for optional preview dependencies (Pandoc) that enable browser and PDF export of generated research artifacts. If Pandoc is not found, setup reports its status. You can run this check again with:
feynman --setup-preview
5

Verify the configuration

After setup completes, it prints a summary showing the active model, alphaXiv status, preview status, and web search routing. Run feynman doctor at any time to re-run these checks:
feynman doctor

Setting a default model

To change your default model without re-running the full setup wizard:
feynman model set <provider/model>
For example:
feynman model set anthropic/claude-sonnet-4-5
To list all models available with your current credentials:
feynman model list

Configuration file

Setup writes to ~/.feynman/settings.json. A typical configuration looks like:
{
  "defaultProvider": "anthropic",
  "defaultModel": "claude-sonnet-4-5",
  "defaultThinkingLevel": "medium"
}
defaultProvider and defaultModel are set together. Use feynman model set <provider/model> to update them — editing manually is also safe when Feynman is not running. See Configuration for all settings fields.

Environment variables

Environment variables take precedence over settings.json and are useful for CI environments or scripted workflows:
VariableDescription
FEYNMAN_MODELOverride the default model
FEYNMAN_THINKINGOverride the thinking level (off, minimal, low, medium, high, xhigh)
FEYNMAN_HOMEOverride the config directory (default: ~/.feynman)
ANTHROPIC_API_KEYAnthropic API key
OPENAI_API_KEYOpenAI API key
GEMINI_API_KEYGoogle Gemini API key
OPENROUTER_API_KEYOpenRouter API key
XAI_API_KEYxAI API key
GROQ_API_KEYGroq API key
MISTRAL_API_KEYMistral API key
CEREBRAS_API_KEYCerebras API key
HF_TOKENHuggingFace token
RUNPOD_API_KEYRunPod API key (for GPU experiments)
MODAL_TOKEN_IDModal token ID (for serverless GPU compute)
MODAL_TOKEN_SECRETModal token secret
Copy .env.example from the repository to .env in your working directory as a starting point. Feynman loads it automatically via dotenv.

Re-running setup

Running feynman setup again overwrites previous settings. If you only need to change a specific value, use the targeted commands:
  • Change model: feynman model set <provider/model>
  • Re-authenticate a provider: feynman model login <provider>
  • alphaXiv login: feynman alpha login
  • Check everything: feynman doctor