npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@warmshao/vsurf

v0.7.6

Published

Coding agent CLI with IPython-backed tools and session management

Downloads

2,031

Readme

VSurf began as a hard fork of vsurf-mono, but it is now developed and distributed independently. This workspace retains inherited @earendil-works/vsurf-* source package identifiers, the vsurf package manifest key, and a source-package vsurf bin entry for internal compatibility. Public releases are currently versioned tarball artifacts installed by the scripts below; release packaging rewrites the application package and command to vsurf. Do not use the inherited npm package as the VSurf install path.

Table of Contents

Quick Start

Requires Node.js >= 22.8.0.

npm install -g @warmshao/vsurf

To install the beta built from the latest commit on main:

npm install -g @warmshao/vsurf@beta

Authenticate with an API key:

export ANTHROPIC_API_KEY=sk-ant-...
vsurf

Or use your existing subscription:

vsurf
/login  # Then select provider

Then just talk to VSurf. By default, VSurf gives the model one tool: ipython. The model uses the persistent kernel to read files, run commands, edit code, and inspect data. Add capabilities via skills, prompt templates, extensions, or VSurf packages.

The Python kernel runtime is set up automatically on first invocation. Set VSURF_KERNEL_PYTHON to use an existing Python environment with ipykernel.

Platform notes: Windows | Termux (Android) | tmux | Terminal setup | Shell aliases

Providers & Models

For each built-in provider, VSurf maintains a list of tool-capable models, updated with every release. Authenticate via subscription (/login) or API key, then select any model from that provider via /model (or Ctrl+L).

Subscriptions:

  • Anthropic Claude Pro/Max
  • OpenAI ChatGPT Plus/Pro (Codex)
  • GitHub Copilot

API keys:

  • Anthropic
  • OpenAI
  • VSurf Inference
  • Azure OpenAI
  • DeepSeek
  • Google Gemini
  • Google Vertex
  • Amazon Bedrock
  • Mistral
  • Groq
  • Cerebras
  • Cloudflare AI Gateway
  • Cloudflare Workers AI
  • xAI
  • OpenRouter
  • Vercel AI Gateway
  • ZAI
  • OpenCode Zen
  • OpenCode Go
  • Hugging Face
  • Fireworks
  • Kimi For Coding
  • MiniMax
  • Xiaomi MiMo
  • Xiaomi MiMo Token Plan (China)
  • Xiaomi MiMo Token Plan (Amsterdam)
  • Xiaomi MiMo Token Plan (Singapore)

See docs/providers.md for detailed setup instructions.

Custom providers & models: Add providers via ~/.vsurf/agent/models.json if they speak a supported API (OpenAI, Anthropic, Google). For custom APIs or OAuth, use extensions. See docs/models.md and docs/custom-provider.md.

Interactive Mode

The interface from top to bottom:

  • Startup header - Shows a compact brand and runtime summary; use --verbose to list loaded AGENTS.md files, prompt templates, skills, and extensions
  • Messages - Your messages, assistant responses, tool calls and results, notifications, errors, and extension UI
  • Editor - Where you type
  • Footer - Empty by default; use /usage for token, cost, and context details

The editor can be temporarily replaced by other UI, like built-in /settings or custom UI from extensions (e.g., a Q&A tool that lets the user answer model questions in a structured format). Extensions can also replace the editor, add widgets above/below it, a status line, custom footer, or overlays.

Editor

| Feature | How | |---------|-----| | File reference | Type @ to fuzzy-search project files | | Path completion | Tab to complete paths | | Multi-line | Shift+Enter (or Ctrl+Enter on Windows Terminal) | | Images | Ctrl+V to paste (Alt+V on Windows), or drag onto terminal | | Bash commands | !command runs and sends output to LLM, !!command runs without sending |

Standard editing keybindings for delete word, undo, etc. See docs/keybindings.md.

Commands

Type / in the editor to trigger commands. Extensions can register custom commands, skills are available as /skill:name, and prompt templates expand via /templatename.

| Command | Description | |---------|-------------| | /login, /logout | OAuth authentication | | /model | Switch models | | /effort | Set reasoning/thinking level | | /scoped-models | Enable/disable models for Ctrl+P cycling | | /settings | Thinking level, theme, message delivery, transport | | /resume [id\|path] | Open the agents view, or resume a session directly | | /new, /clear | Start a new session | | /name <name> | Set session display name | | /session | Show session info (file, ID, messages) | | /traces [status\|on\|off\|preview\|upload-current\|upload-all\|login] | Preview traces, run one-shot current/all uploads, and manage automatic sharing (upload aliases upload-current) | | /usage | Show token, cost, and context usage | | /tree | Jump to any point in the session and continue from there | | /fork | Create a new session from a previous user message | | /clone | Duplicate the current active branch into a new session | | /compact [prompt] | Manually compact context, optional custom instructions | | /copy | Copy last assistant message to clipboard | | /btw <question>, /side <question> | Ask an inline side question without adding it to the session; replies continue the side conversation, esc returns | | /export [file] | Export session to HTML file | | /share | Upload as private GitHub gist with shareable HTML link | | /reload | Reload keybindings, extensions, skills, prompts, and context files (themes hot-reload automatically) | | /hotkeys | Show all keyboard shortcuts | | /changelog | Display version history | | /quit | Quit VSurf |

Keyboard Shortcuts

See /hotkeys for the full list. Customize via ~/.vsurf/agent/keybindings.json. See docs/keybindings.md.

Commonly used:

| Key | Action | |-----|--------| | Ctrl+C | Interrupt active work, or show the exit hint when idle | | Ctrl+C twice | Exit while the exit hint is visible | | Escape | Clear the input without interrupting active work | | Escape twice | Open /tree | | Ctrl+L | Open model selector | | Ctrl+P / Shift+Ctrl+P | Cycle scoped models forward/backward | | Ctrl+O | Collapse/expand tool output | | Ctrl+T | Collapse/expand thinking blocks |

Message Queue

Submit messages while the agent is working:

  • Enter queues a steering message, delivered after the current assistant turn finishes executing its tool calls
  • Alt+Enter queues a follow-up message, delivered only after the agent finishes all work
  • Ctrl+C interrupts active work; queued messages are kept and resume after your next submit or edit
  • Escape clears the input without interrupting active work
  • Alt+Up / Alt+Down browse queued messages individually and return to the editor draft
  • While browsing, Enter applies the edit as steering input and Alt+Enter applies it as a follow-up; submitting an empty edit deletes the item
  • Ctrl+Alt+Up / Ctrl+Alt+Down move the selected item earlier or later within its queue

On Windows Terminal, Alt+Enter is fullscreen by default. Remap it in docs/terminal-setup.md so VSurf can receive the follow-up shortcut.

Configure delivery in settings: steeringMode and followUpMode can be "one-at-a-time" (default, waits for response) or "all" (delivers all queued at once). transport selects provider transport preference ("sse", "websocket", or "auto") for providers that support multiple transports.

Sessions

Sessions are stored as JSONL files with a tree structure. Each entry has an id and parentId, enabling in-place branching without creating new files. See docs/session-format.md for file format.

Management

Sessions auto-save as flat JSONL files under ~/.vsurf/agent/sessions/. Each session header records its working directory, which the searchable session view uses to identify and open saved sessions.

vsurf -c                  # Continue most recent session
vsurf -r [path|id]        # Browse past sessions or resume one directly
vsurf --no-session        # Ephemeral mode (don't save)
vsurf --fork <path|id>    # Fork specific session file or ID into a new session

Use /session in interactive mode to see the current session ID before reusing it with --resume <id> or --fork <id>.

Branching

/tree - Navigate the session tree in-place. Select any previous point, continue from there, and switch between branches. All history preserved in a single file.

  • Search by typing, fold/unfold and jump between branches with Ctrl+←/Ctrl+→ or Alt+←/Alt+→, page with ←/→
  • Filter modes (Ctrl+O): default → no-tools → user-only → labeled-only → all
  • Press Shift+L to label entries as bookmarks and Shift+T to toggle label timestamps

/fork - Create a new session file from a previous user message on the active branch. Opens a selector, copies the active path up to that point, and places the selected prompt in the editor for modification.

/clone - Duplicate the current active branch into a new session file at the current position. The new session keeps the full active-path history and opens with an empty editor.

--fork <path|id> - Fork an existing session file or partial session UUID directly from the CLI. This copies the full source session into a new session file in the current project.

Compaction

Long sessions can exhaust context windows. Compaction summarizes older messages while keeping recent ones.

Manual: /compact or /compact <custom instructions>

Automatic: Enabled by default. Triggers on context overflow (recovers and retries) or when approaching the limit (proactive). Configure via /settings or settings.json.

Compaction is lossy. The full history remains in the JSONL file; use /tree to revisit. Customize compaction behavior via extensions. See docs/compaction.md for internals.

Settings

Use /settings to modify common options, or edit JSON files directly:

| Location | Scope | |----------|-------| | ~/.vsurf/agent/settings.json | Global (all projects) | | .vsurf/agent/settings.json | Project (overrides global) |

See docs/settings.md for all options.

Update checks

VSurf stable builds check the npm registry's latest dist-tag to see whether a newer version exists. Beta builds follow the beta dist-tag and remain on the beta channel. Override the registry URL with VSURF_NPM_REGISTRY_URL. Disable version checks with VSURF_SKIP_VERSION_CHECK=1.

Use --offline or VSURF_OFFLINE=1 to disable startup network operations, including update checks and package update checks.

Context Files

VSurf loads AGENTS.md (or CLAUDE.md) at startup from:

  • ~/.vsurf/agent/AGENTS.md (global)
  • Parent directories (walking up from cwd)
  • Current directory

Use for project instructions, conventions, common commands. All matching files are concatenated.

Disable context file loading with --no-context-files (or -nc).

System Prompt

Replace the default system prompt with .vsurf/agent/SYSTEM.md (project) or ~/.vsurf/agent/SYSTEM.md (global). Append without replacing via APPEND_SYSTEM.md.

Customization

Prompt Templates

Reusable prompts as Markdown files. Type /name to expand.

<!-- ~/.vsurf/agent/prompts/review.md -->
Review this code for bugs, security issues, and performance problems.
Focus on: {{focus}}

Place in ~/.vsurf/agent/prompts/, .vsurf/agent/prompts/, or a VSurf package to share with others. See docs/prompt-templates.md.

Skills

On-demand capability packages following the Agent Skills standard. At startup, VSurf gives the model each visible skill's name, type, description, and location. The full SKILL.md stays out of context until the model inspects it with ipython or you explicitly invoke /skill:name.

<!-- ~/.vsurf/agent/skills/my-skill/SKILL.md -->
---
name: my-skill
description: Use this skill when the user asks about X.
---

# My Skill

## Steps
1. Do this
2. Then that

Skills can also be Python-backed. A Python skill is a normal skill directory with SKILL.md plus a Python package at src/<import_name>/. VSurf installs it into the persistent IPython kernel and exposes it by import name, so the model can call it directly, inspect it with help(), or use any console scripts the skill declares.

Place in ~/.vsurf/agent/skills/, ~/.agents/skills/, .vsurf/agent/skills/, or .agents/skills/ (from cwd up through parent directories) or a VSurf package to share with others. See docs/skills.md.

VSurf ships with a built-in websearch skill (Google search via the Serper API). It loads by default; run /login, switch to MCP Connections, and choose "Serper (web search)" to add your key. Disable it with bundledSkills.websearch: false, or override it with your own websearch skill in any location above. See docs/skills.md#built-in-skills.

MCP Integrations

Connect external services (Linear, Notion, …) over the Model Context Protocol. Consistent with the single-tool design, MCP is not exposed as new agent tools — each integration is a Python skill package the model imports and calls from the kernel:

import linear
issues = await linear.list_issues(team="Engineering")   # tools auto-discovered from the server
help(linear.list_issues)                                 # description + argument schema

Built-in integrations for Linear and Notion ship disabled. Logging in enables them: open /login, switch to MCP Connections, pick the integration, and complete OAuth in the browser. The integration's skill then becomes visible and is auto-imported into the kernel. /mcp opens the same tab, while its subcommands support direct management:

/mcp                 list integrations and connection status
/mcp login <name>    connect via OAuth (browser)
/mcp logout <name>   disconnect

Credentials are stored once in ~/.vsurf/agent/auth.json (under mcp:<name>); the kernel reads them directly and the host refreshes expired tokens. Enablement is derived from whether valid credentials exist, so there is no separate on/off switch.

Add your own server. Declare it under mcpServers in settings, then ship a tiny Python skill package that subclasses McpIntegration:

// ~/.vsurf/agent/settings.json
{
  "mcpServers": {
    "acme": { "type": "http", "url": "https://mcp.acme.com/mcp", "oauth": true }
  }
}
# ~/.vsurf/agent/skills/acme/src/acme/__init__.py
from rlm import McpIntegration

class Acme(McpIntegration):
    server = "acme"
    url = "https://mcp.acme.com/mcp"

acme = Acme()

def __getattr__(name):     # so `import acme; await acme.<tool>(...)` works
    return getattr(acme, name)

The base class connects with the official mcp SDK, injects the bearer token from auth.json, and binds the server's tools as async methods. Use await acme.call_tool("name", {...}) for tools whose names aren't valid Python identifiers, or a static bearerTokenEnvVar instead of OAuth.

See docs/mcp-integrations.md for the full authoring guide (package layout, auth options, the McpIntegration API, and caveats).

Extensions

TypeScript modules that extend VSurf with custom tools, commands, keyboard shortcuts, event handlers, and UI components.

export default function (vsurf: ExtensionAPI) {
  vsurf.registerTool({ name: "deploy", ... });
  vsurf.registerCommand("stats", { ... });
  vsurf.on("tool_call", async (event, ctx) => { ... });
}

The default export can also be async. VSurf waits for async extension factories before startup continues, which is useful for one-time initialization such as fetching remote model lists before calling vsurf.registerProvider().

What's possible:

  • Custom tools (or replace built-in tools entirely)
  • Additional orchestration workflows and plan modes
  • Custom compaction and summarization
  • Permission gates and path protection
  • Custom editors and UI components
  • Status lines, headers, footers
  • Git checkpointing and auto-commit
  • SSH and sandbox execution
  • MCP server integration
  • Make VSurf look like Claude Code
  • Games while waiting (yes, Doom runs)
  • ...anything you can dream up

Place in ~/.vsurf/agent/extensions/, .vsurf/agent/extensions/, or a VSurf package to share with others. See docs/extensions.md and examples/extensions/.

Themes

Built-in: dark, light. Themes hot-reload: modify the active theme file and VSurf immediately applies changes.

Place in ~/.vsurf/agent/themes/, .vsurf/agent/themes/, or a VSurf package to share with others. See docs/themes.md.

VSurf Packages

Bundle and share extensions, skills, prompts, and themes via npm or git.

Security: VSurf packages run with full system access. Extensions execute arbitrary code, and skills can instruct the model to perform any action including running executables. Review source code before installing third-party packages.

vsurf package install npm:@foo/vsurf-tools
vsurf package install npm:@foo/[email protected]  # pinned version
vsurf package install git:github.com/user/repo
vsurf package install git:github.com/user/repo@v1       # tag or commit
vsurf package install git:[email protected]:user/repo
vsurf package install https://github.com/user/repo
vsurf package install ssh://[email protected]/user/repo
vsurf package remove npm:@foo/vsurf-tools
vsurf package list
vsurf package update                                  # update packages, except pinned versions
vsurf package update npm:@foo/vsurf-tools       # update one package
vsurf update                                          # update VSurf
vsurf update --force                                  # reinstall VSurf even if current
vsurf config                                          # enable/disable package resources

Packages install to ~/.vsurf/agent/git/ (git) or global npm. Use --local for project-local installs (.vsurf/agent/git/, .vsurf/agent/npm/). Git packages install dependencies with npm install --omit=dev by default, so runtime deps must be listed under dependencies; when npmCommand is configured, git packages use plain install for compatibility with wrappers. If you use a Node version manager and want package installs to reuse a stable npm context, set npmCommand in settings.json, for example ["mise", "exec", "node@20", "--", "npm"].

Create a package by adding the inherited vsurf manifest key to package.json:

{
  "name": "my-vsurf-package",
  "keywords": ["vsurf-package"],
  "vsurf": {
    "extensions": ["./extensions"],
    "skills": ["./skills"],
    "prompts": ["./prompts"],
    "themes": ["./themes"]
  }
}

Without a vsurf manifest, VSurf auto-discovers from conventional directories (extensions/, skills/, prompts/, themes/).

See docs/packages.md.

Programmatic Usage

SDK

import { AuthStorage, createAgentSession, ModelRegistry, SessionManager } from "vsurf";

const authStorage = AuthStorage.create();
const modelRegistry = ModelRegistry.create(authStorage);
const { session } = await createAgentSession({
  sessionManager: SessionManager.inMemory(),
  authStorage,
  modelRegistry,
});

await session.prompt("What files are in the current directory?");

For advanced multi-session runtime replacement, use createAgentSessionRuntime() and AgentSessionRuntime.

See docs/sdk.md and examples/sdk/.

RPC Mode

For non-Node.js integrations, use RPC mode over stdin/stdout:

vsurf --mode rpc

RPC mode uses strict LF-delimited JSONL framing. Clients must split records on \n only. Do not use generic line readers like Node readline, which also split on Unicode separators inside JSON payloads.

See docs/rpc.md for the protocol.

Upstream

VSurf is forked from vsurf-mono by Mario Zechner and keeps MIT attribution in the root license.

The package architecture, extension model, and source package names still reflect that upstream lineage while the distributed command and release artifacts are branded for VSurf.

CLI Reference

vsurf [options] [@files...] [messages...]

Run vsurf help for the command list and vsurf help <command> for details.

Agent Commands

vsurf agents                         # Search running, idle, and inactive sessions
vsurf list [--all]                   # List active or saved agents
vsurf attach <agent>                 # Attach the interactive UI
vsurf stop <agent>                   # Stop one agent
vsurf rename <agent> <name>          # Rename an agent
vsurf send <agent> <message>         # Send an agent-to-agent message
vsurf status                         # Show background service status
vsurf doctor [--fix]                 # Inspect or safely clean up background services
vsurf shutdown [--force]             # Stop every agent, worker, and background service

shutdown asks for confirmation. shutdown --force skips confirmation and kills unresponsive workers and their tracked child processes.

Scheduled Prompts

vsurf schedule list [--all] [agent]
vsurf schedule add <agent> <schedule> -- <message>
vsurf schedule cancel <job-id>

Schedules run prompts later or repeatedly. A schedule can be a supported one-time expression such as in 5m or a cron expression.

Package and Update Commands

Packages bundle capabilities such as extensions, skills, prompts, and themes.

vsurf package install <source> [--local]
vsurf package remove <source> [--local]
vsurf package list
vsurf package update [source]
vsurf update [--force]                   # Update VSurf itself
vsurf config                             # Enable/disable package resources

Modes

| Flag | Description | |------|-------------| | (default) | Interactive mode | | -p, --print | Print response and exit | | --mode json | Output all events as JSON lines (see docs/json.md) | | --mode rpc | RPC mode for process integration (see docs/rpc.md) |

In print mode, VSurf also reads piped stdin and merges it into the initial prompt:

cat README.md | vsurf -p "Summarize this text"

Model Options

| Option | Description | |--------|-------------| | --provider <name> | Provider (anthropic, openai, google, etc.) | | --model <pattern> | Model pattern or ID (supports provider/id and optional :<thinking>) | | --api-key <key> | API key (overrides env vars) | | --thinking <level> | off, minimal, low, medium, high, xhigh | | --models <patterns> | Comma-separated patterns for Ctrl+P cycling |

Use vsurf model list [search] to list available models.

Session Options

| Option | Description | |--------|-------------| | -c, --continue | Continue most recent session | | -r, --resume [path\|id] | Open the searchable session view, or resume a specific session file or partial UUID | | --fork <path\|id> | Fork specific session file or partial UUID into a new session | | --session-dir <dir> | Custom session storage directory | | --no-session | Ephemeral mode (don't save) |

Use vsurf session export <file> [output] to export a saved session to HTML.

Tool Options

| Option | Description | |--------|-------------| | --tools <list>, -t <list> | Allowlist specific tool names across built-in, extension, and custom tools | | --no-builtin-tools, -nbt | Disable built-in tools by default but keep extension/custom tools enabled | | --no-tools, -nt | Disable all tools by default |

Available built-in tools: ipython

Resource Options

| Option | Description | |--------|-------------| | -e, --extension <source> | Load extension from path, npm, or git (repeatable) | | --no-extensions | Disable extension discovery | | --skill <path> | Load skill (repeatable) | | --no-skills | Disable skill discovery | | --prompt-template <path> | Load prompt template (repeatable) | | --no-prompt-templates | Disable prompt template discovery | | --theme <path> | Load theme (repeatable) | | --no-themes | Disable theme discovery | | --no-context-files, -nc | Disable AGENTS.md and CLAUDE.md context file discovery |

Combine --no-* with explicit flags to load exactly what you need, ignoring settings.json (e.g., --no-extensions -e ./my-ext.ts).

Autonomous Options

Autonomous mode is disabled by default. --autonomous or any of its sub-options enables host-managed continuations for unattended work.

| Option | Description | |--------|-------------| | --autonomous | Continue until gates pass or a limit prevents another continuation | | --autonomous-gate <command> | Add a repeatable shell command that must pass before completion | | --autonomous-gate-retries <n> | Positive per-gate retry limit; default 3 | | --autonomous-gate-timeout-ms <n> | Positive per-gate timeout in milliseconds; default 300000 | | --autonomous-max-continuations <n> | Positive host follow-up limit; default 3 | | --autonomous-max-turns <n> | Positive assistant-turn limit; default 12 | | --autonomous-max-tokens <n> | Positive token limit; default 80000 | | --autonomous-timeout-ms <n> | Positive wall-clock limit in milliseconds; default 1800000 |

Gates run before the continuation, turn, token, and wall-clock limits are evaluated; every configured gate must pass for autonomous completion. See the usage guide for validation rules, retry behavior, and detailed limit interactions.

Other Options

| Option | Description | |--------|-------------| | --system-prompt <text> | Replace default prompt (context files and skills still appended) | | --append-system-prompt <text> | Append to system prompt | | --verbose | Force verbose startup | | -h, --help | Show help | | -v, --version | Show version |

File Arguments

Prefix files with @ to include in the message:

vsurf @prompt.md "Answer this"
vsurf -p @screenshot.png "What's in this image?"
vsurf @code.ts @test.ts "Review these files"

Examples

# Interactive with initial prompt
vsurf "List all .ts files in src/"

# Non-interactive
vsurf -p "Summarize this codebase"

# Non-interactive with piped stdin
cat README.md | vsurf -p "Summarize this text"

# Different model
vsurf --provider openai --model gpt-4o "Help me refactor"

# Model with provider prefix (no --provider needed)
vsurf --model openai/gpt-4o "Help me refactor"

# Model with thinking level shorthand
vsurf --model sonnet:high "Solve this complex problem"

# Limit model cycling
vsurf --models "claude-*,gpt-4o"

# Restrict to the built-in IPython tool
vsurf --tools ipython -p "Review the code"

# High thinking level
vsurf --thinking high "Solve this complex problem"

Environment Variables

| Variable | Description | |----------|-------------| | VSURF_CODING_AGENT_DIR | Override config directory (default: ~/.vsurf/agent) | | VSURF_SESSION_DIR | Override session storage directory (overridden by --session-dir) | | VSURF_CODING_AGENT_SESSION_DIR | Legacy alias for VSURF_SESSION_DIR | | VSURF_PACKAGE_DIR | Override package directory (useful for Nix/Guix where store paths tokenize poorly) | | VSURF_OFFLINE | Disable startup network operations, including update checks and package update checks | | VSURF_SKIP_VERSION_CHECK | Skip the VSurf version update check at startup. This prevents the npm registry request | | VSURF_TELEMETRY | Override pseudonymous aggregate usage analytics with 1/true/yes or 0/false/no | | VSURF_TELEMETRY_ENDPOINT | Override the aggregate analytics ingestion endpoint | | DO_NOT_TRACK | Disable aggregate usage analytics when set to 1/true/yes | | VSURF_NPM_REGISTRY_URL | Override the npm registry URL used for version update checks | | VSURF_CACHE_RETENTION | Set to long for extended prompt cache (Anthropic: 1h, OpenAI: 24h) | | VSURF_API_KEY | VSurf Inference API key; also used for trace sharing if it has agent_traces scope | | VSURF_TRACES_API_KEY | Prime API key used only for opt-in trace sharing | | VSURF_TRACES_BASE_URL | Override the VSurf trace upload API base URL | | VSURF_KERNEL_PYTHON | Use an existing Python environment with ipykernel instead of auto-bootstrapping ~/.vsurf/agent/kernel-venv | | VISUAL, EDITOR | External editor for Ctrl+G |

The remaining VSURF_* variables in this table are compatibility names still read by the current runtime. They do not change the application name, command, or default ~/.vsurf/agent configuration path.

Contributing & Development

See docs/development.md for setup and debugging.

License

MIT

See Also