### Setup Modal CLI Source: https://github.com/companion-inc/feynman/blob/main/skills/modal-compute/SKILL.md Install the Modal package and authenticate the environment. ```bash pip install modal modal setup ``` -------------------------------- ### Install and Configure runpodctl Source: https://github.com/companion-inc/feynman/blob/main/skills/runpod-compute/SKILL.md Initial setup for the RunPod CLI on macOS and API key configuration. ```bash brew install runpod/runpodctl/runpodctl # macOS runpodctl config --apiKey=YOUR_KEY ``` -------------------------------- ### Install Feynman on macOS or Linux Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/installation.md Use the curl one-line installer to automatically detect architecture and install the runtime bundle. ```bash curl -fsSL https://feynman.is/install | bash ``` -------------------------------- ### Install Skills for OpenCode Source: https://github.com/companion-inc/feynman/blob/main/README.md Installs the skill library into the current repository's .opencode directory. ```bash curl -fsSL https://feynman.is/install-skills | bash -s -- --opencode ``` ```powershell & ([scriptblock]::Create((irm https://feynman.is/install-skills.ps1))) -Scope OpenCode ``` -------------------------------- ### Install Skills for Repo Source: https://github.com/companion-inc/feynman/blob/main/README.md Installs the skill library into the current repository's .agents directory. ```bash curl -fsSL https://feynman.is/install-skills | bash -s -- --repo ``` ```powershell & ([scriptblock]::Create((irm https://feynman.is/install-skills.ps1))) -Scope Repo ``` -------------------------------- ### Run Feynman setup Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/setup.md Initiate the configuration wizard to set up model providers and authentication. ```bash feynman setup ``` -------------------------------- ### Install Feynman on Windows Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/installation.md Run the PowerShell installer as Administrator to set up the x64 runtime bundle and update the user PATH. ```powershell irm https://feynman.is/install.ps1 | iex ``` -------------------------------- ### Install dependencies Source: https://github.com/companion-inc/feynman/blob/main/CONTRIBUTING.md Commands to set up the local development environment using NVM and NPM. ```bash nvm use || nvm install npm install ``` -------------------------------- ### Start the Science Workbench Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/workbench.md Launches the local server and opens the workbench interface. ```bash feynman serve ``` ```bash feynman serve --no-auth ``` -------------------------------- ### Initialize Feynman development environment Source: https://github.com/companion-inc/feynman/blob/main/README.md Commands to clone the repository, install dependencies, and verify the build. ```bash git clone https://github.com/companion-inc/feynman.git cd feynman nvm use || nvm install npm install npm test npm run typecheck npm run build ``` -------------------------------- ### feynman packages install Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/reference/cli-commands.md Installs a specific optional package preset. ```APIDOC ## feynman packages install ### Description Install an optional package preset. ### Parameters - **preset** (string) - Required - The name of the package preset to install. ``` -------------------------------- ### Install Feynman Skills Library Source: https://github.com/companion-inc/feynman/blob/main/README.md Installs only the research skills library without the full terminal application. ```bash curl -fsSL https://feynman.is/install-skills | bash ``` ```powershell irm https://feynman.is/install-skills.ps1 | iex ``` -------------------------------- ### Install Feynman skills via Bash Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/installation.md Use these commands on Unix-based systems to install skills into specific project or user directories. ```bash curl -fsSL https://feynman.is/install-skills | bash ``` ```bash curl -fsSL https://feynman.is/install-skills | bash -s -- --codex ``` ```bash curl -fsSL https://feynman.is/install-skills | bash -s -- --repo ``` ```bash curl -fsSL https://feynman.is/install-skills | bash -s -- --opencode ``` -------------------------------- ### Install Feynman skills via PowerShell Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/installation.md Use these commands on Windows systems to install skills into specific project or user directories. ```powershell irm https://feynman.is/install-skills.ps1 | iex ``` ```powershell & ([scriptblock]::Create((irm https://feynman.is/install-skills.ps1))) -Scope Codex ``` ```powershell & ([scriptblock]::Create((irm https://feynman.is/install-skills.ps1))) -Scope Repo ``` ```powershell & ([scriptblock]::Create((irm https://feynman.is/install-skills.ps1))) -Scope OpenCode ``` -------------------------------- ### Verify preview dependencies Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/tools/preview.md Run this command to check for or install necessary rendering dependencies like pandoc. ```bash feynman setup preview ``` -------------------------------- ### Verify Feynman installation Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/installation.md Checks the installed version of the CLI to confirm accessibility. ```bash feynman --version ``` -------------------------------- ### Install Skills for Codex Source: https://github.com/companion-inc/feynman/blob/main/README.md Installs the skill library specifically for the Codex environment. ```bash curl -fsSL https://feynman.is/install-skills | bash -s -- --codex ``` ```powershell & ([scriptblock]::Create((irm https://feynman.is/install-skills.ps1))) -Scope Codex ``` -------------------------------- ### Launch the Feynman REPL Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/quickstart.md Starts an interactive conversational session for research and agent interaction. ```bash feynman ``` -------------------------------- ### Validate website changes Source: https://github.com/companion-inc/feynman/blob/main/CONTRIBUTING.md Commands to install and build the documentation website after making modifications. ```bash cd website npm install npm run build ``` -------------------------------- ### Open the Science Workbench Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/quickstart.md Starts a local authenticated web application for managing projects, notebooks, and compute. ```bash feynman serve ``` -------------------------------- ### Select model in wizard Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/setup.md Example of the interactive model selection prompt using arrow keys. ```text ? Select your default model: > provider:approved-model-from-your-list provider:another-approved-model ``` -------------------------------- ### Install Feynman CLI Source: https://github.com/companion-inc/feynman/blob/main/README.md Fetches the latest tagged release of the Feynman CLI for macOS/Linux or Windows. ```bash curl -fsSL https://feynman.is/install | bash ``` ```powershell irm https://feynman.is/install.ps1 | iex ``` -------------------------------- ### Custom provider configuration Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/setup.md Selection and example settings for custom OpenAI-compatible local servers like Ollama. ```text Custom provider (baseUrl + API key) ``` ```text API mode: openai-completions Base URL: http://localhost:11434/v1 Authorization header: No Model ids: llama3.1:8b API key: local ``` -------------------------------- ### Install optional package preset Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/reference/package-stack.md Adds a specific optional package preset to the Feynman environment. ```bash feynman packages install session-search ``` -------------------------------- ### Agent Settings Configuration Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/configuration.md Example of the agent/settings.json file used for defining default providers and model behavior. ```json { "defaultProvider": "openai", "defaultModel": "", "defaultThinkingLevel": "medium" } ``` -------------------------------- ### Re-run setup or modify configuration Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/setup.md Commands for resetting the environment or updating specific configuration values. ```bash feynman setup ``` ```bash feynman model set ``` ```bash feynman alpha login ``` -------------------------------- ### List optional research packages Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/reference/package-stack.md Displays all supported optional packages and their current installation status. ```bash feynman packages list ``` -------------------------------- ### Start the Science Workbench without Authentication Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/reference/cli-commands.md Launches a trusted local-only session accessible via a plain URL without requiring a launch token. ```bash feynman serve --no-auth ``` -------------------------------- ### feynman serve Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/reference/cli-commands.md Starts the local science workbench web application. By default, it requires authentication via a launch token, but can be run in an unauthenticated local-only mode. ```APIDOC ## feynman serve ### Description Starts a local authenticated web app for research runs that provides a control plane for projects, sessions, and various bio-tool workflows. ### Usage `feynman serve [options]` ### Options - `--no-auth` (flag) - Optional - If provided, starts the server in a trusted local-only session without requiring a launch token. The server will be accessible at http://127.0.0.1:/. ``` -------------------------------- ### Check runpodctl Installation Source: https://github.com/companion-inc/feynman/blob/main/skills/runpod-compute/SKILL.md Verify if the runpodctl CLI is installed in the current environment. ```bash command -v runpodctl ``` -------------------------------- ### Find an ML training recipe Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/quickstart.md Generates a practical implementation brief for a specified machine learning task. ```bash feynman recipe "fine-tune a small model for math reasoning" ``` -------------------------------- ### Initiate replication from CLI Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/workflows/replication.md Execute the replication workflow for a paper or claim using the command line interface. ```bash feynman replicate "paper or claim" ``` -------------------------------- ### Install Feynman via npm Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/installation.md Installs the Feynman package globally using npm. Requires Node.js version >=22.22.0 <26. ```bash npm install -g @companion-ai/feynman ``` -------------------------------- ### List configured models Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/configuration.md Displays all models currently authenticated and configured for use. ```bash feynman model list ``` -------------------------------- ### Inappropriate Prompt Examples Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/workflows/biomedical-literature-review.md Examples of prompts that should be avoided when using Feynman for biomedical topics, as they solicit direct medical advice or diagnosis. ```text What should this patient do? Which treatment should I choose for this case? Diagnose this patient. ``` -------------------------------- ### Verify and set model Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/setup.md Commands to list available models and set the default model after configuration. ```bash feynman model list feynman model set / ``` -------------------------------- ### Research Question Framing Examples Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/workflows/biomedical-literature-review.md Examples of how to phrase research tasks for Feynman when dealing with sensitive topics like diagnosis or treatment. Focus on literature synthesis rather than direct advice. ```text Summarize the research literature on... Compare the evidence for... Identify limitations and gaps in studies about... Draft a background section for a research protocol on... ``` -------------------------------- ### feynman update Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/reference/cli-commands.md Updates installed packages globally or a specific package by name. ```APIDOC ## feynman update [package] ### Description Update installed packages, or a specific package by name. ### Parameters - **package** (string) - Optional - The name of the specific package to update. ``` -------------------------------- ### Run Recipe Workflow from REPL Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/workflows/recipe.md Initiate the recipe workflow from the REPL to find implementable ML training recipes for a specified goal. ```bash /recipe "fine-tune a small model for math reasoning" ``` -------------------------------- ### Uninstall Feynman via npm Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/installation.md Removes the globally installed Feynman package. ```bash npm uninstall -g @companion-ai/feynman ``` -------------------------------- ### Update packages Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/reference/package-stack.md Reconciles installed packages with configured versions or updates a specific package. ```bash feynman update ``` ```bash feynman update pi-subagents ``` -------------------------------- ### Check Modal Availability Source: https://github.com/companion-inc/feynman/blob/main/skills/modal-compute/SKILL.md Verify if the modal CLI is installed and available in the current shell. ```bash command -v modal ``` -------------------------------- ### Start a deep research session Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/quickstart.md Initiates a multi-agent research workflow within the REPL. ```bash feynman > /deepresearch What are the current approaches to mechanistic interpretability in LLMs? ``` -------------------------------- ### feynman packages list Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/reference/cli-commands.md Lists all supported optional research packages and their current installation status. ```APIDOC ## feynman packages list ### Description Lists supported optional research packages and their install status. ### Usage `feynman packages list` ``` -------------------------------- ### Update Feynman via npm Source: https://github.com/companion-inc/feynman/blob/main/website/src/content/docs/getting-started/installation.md Upgrades the globally installed Feynman package to the latest version. ```bash npm install -g @companion-ai/feynman@latest ``` -------------------------------- ### Build and run from a Dockerfile Source: https://github.com/companion-inc/feynman/blob/main/skills/docker/SKILL.md Builds a custom image from a local Dockerfile and runs it with a specific results directory mounted. ```bash docker build -t feynman-experiment . docker run --rm -v "$(pwd)/results":/workspace/results feynman-experiment ```