Installation

Feynman ships as a standalone runtime bundle for macOS, Linux, and Windows, and as a package-manager install for environments where Node.js is already installed. The recommended approach is the one-line installer, which downloads a prebuilt native bundle with zero external runtime dependencies.

One-line installer (recommended)

On macOS or Linux, open a terminal and run:

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

The installer detects your OS and architecture automatically. On macOS it supports both Intel and Apple Silicon. On Linux it supports x64 and arm64. The launcher is installed to ~/.local/bin, the bundled runtime is unpacked into ~/.local/share/feynman, and your PATH is updated when needed.

If you previously installed Feynman via npm, pnpm, or bun and still see local Node.js errors after a curl install, your shell is probably still resolving the older global binary first. Run which -a feynman, then hash -r, or launch the standalone shim directly with ~/.local/bin/feynman.

On Windows, open PowerShell as Administrator and run:

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

This installs the Windows runtime bundle under %LOCALAPPDATA%\Programs\feynman, adds its launcher to your user PATH, and lets you re-run the installer at any time to update.

Skills only

If you only want Feynman’s research skills and not the full terminal runtime, install the skill library separately.

For a user-level install into ~/.codex/skills/feynman:

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

For a repo-local install into .agents/skills/feynman under the current repository:

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

On Windows, install the skills into your Codex skill directory:

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

Or install them repo-locally:

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

These installers download only the skills/ tree from the Feynman repository. They do not install the Feynman terminal, bundled Node runtime, auth storage, or Pi packages.

Pinned releases

The one-line installer already targets the latest tagged release. To pin an exact version, pass it explicitly:

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

On Windows:

& ([scriptblock]::Create((irm https://feynman.is/install.ps1))) -Version 0.2.14

pnpm

If you already have Node.js 20.19.0 or newer installed, you can install Feynman globally via pnpm:

pnpm add -g @companion-ai/feynman

Or run it directly without installing:

pnpm dlx @companion-ai/feynman

bun

bun add -g and bunx still use your local Node runtime for Feynman itself, so the same Node.js 20.19.0+ requirement applies.

bun add -g @companion-ai/feynman

Or run it directly without installing:

bunx @companion-ai/feynman

Both package-manager distributions ship the same core application but depend on Node.js being present on your system. The standalone installer is preferred because it bundles its own Node runtime and works without a separate Node installation.

Post-install setup

After installation, run the guided setup wizard to configure your model provider and API keys:

feynman setup

This walks you through selecting a default model, authenticating with your provider, and optionally installing extra packages for features like web search and document preview. See the Setup guide for a detailed walkthrough.

Verifying the installation

Confirm Feynman is installed and accessible:

feynman --version

If you see a version number, you are ready to go. Run feynman doctor at any time to diagnose configuration issues, missing dependencies, or authentication problems.

Local development

For contributing or running Feynman from source:

git clone https://github.com/getcompanion-ai/feynman.git
cd feynman
nvm use || nvm install
pnpm install
pnpm start