> ## 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.

# Installation

> Install Feynman on macOS, Linux, or Windows using the one-line installer, pnpm, or bun.

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 present. The recommended approach is the one-line installer, which downloads a prebuilt native bundle with no external runtime dependencies.

## One-line installer (recommended)

The installer detects your OS and architecture automatically. On macOS it supports both Intel and Apple Silicon. On Linux it supports x64 and arm64.

<CodeGroup>
  ```bash macOS / Linux theme={null}
  curl -fsSL https://feynman.is/install | bash
  ```

  ```powershell Windows (PowerShell) theme={null}
  irm https://feynman.is/install.ps1 | iex
  ```
</CodeGroup>

On macOS and Linux, the launcher is installed to `~/.local/bin`, the bundled runtime is unpacked into `~/.local/share/feynman`, and your `PATH` is updated when needed.

On Windows, the runtime bundle is installed under `%LOCALAPPDATA%\Programs\feynman` and its launcher is added to your user `PATH`. Re-run the installer at any time to update.

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

## Skills only

If you only want Feynman's research skills without the full terminal runtime, install the skill library separately.

**User-level install** into `~/.codex/skills/feynman`:

<CodeGroup>
  ```bash macOS / Linux theme={null}
  curl -fsSL https://feynman.is/install-skills | bash
  ```

  ```powershell Windows (PowerShell) theme={null}
  irm https://feynman.is/install-skills.ps1 | iex
  ```
</CodeGroup>

**Repo-local install** into `.agents/skills/feynman` under the current repository:

<CodeGroup>
  ```bash macOS / Linux theme={null}
  curl -fsSL https://feynman.is/install-skills | bash -s -- --repo
  ```

  ```powershell Windows (PowerShell) theme={null}
  & ([scriptblock]::Create((irm https://feynman.is/install-skills.ps1))) -Scope Repo
  ```
</CodeGroup>

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

## Pinned version

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

<CodeGroup>
  ```bash macOS / Linux theme={null}
  curl -fsSL https://feynman.is/install | bash -s -- 0.2.15
  ```

  ```powershell Windows (PowerShell) theme={null}
  & ([scriptblock]::Create((irm https://feynman.is/install.ps1))) -Version 0.2.15
  ```
</CodeGroup>

## pnpm

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

```bash theme={null}
pnpm add -g @companion-ai/feynman
```

Or run it without installing:

```bash theme={null}
pnpm dlx @companion-ai/feynman
```

## bun

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

```bash theme={null}
bun add -g @companion-ai/feynman
```

Or run it without installing:

```bash theme={null}
bunx @companion-ai/feynman
```

<Tip>
  Both package-manager distributions ship the same core application but require Node.js to be present on your system. The standalone curl installer is preferred because it bundles its own Node runtime.
</Tip>

## Node.js version requirement

When installing via pnpm or bun, Node.js `20.19.0` or newer is required. The standalone curl installer bundles its own Node runtime and does not require a system Node installation.

## Post-install setup

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

```bash theme={null}
feynman setup
```

This walks you through selecting a default model, authenticating with your provider, and optionally connecting to alphaXiv. See the [Setup guide](/getting-started/setup) for a full walkthrough.

## Verifying the installation

Confirm Feynman is installed and on your `PATH`:

```bash theme={null}
feynman --version
```

If you see a version number, you are ready to go. Run `feynman doctor` at any time to check configuration, authentication status, and optional dependencies:

```bash theme={null}
feynman doctor
```

## Local development

To contribute or run Feynman from source:

```bash theme={null}
git clone https://github.com/getcompanion-ai/feynman.git
cd feynman
nvm use || nvm install
npm install
npm start
```