\n\n> This is the `@leanandmean/coding-agent` runtime package. Most users should install [`@leanandmean/scramjet`](https://www.npmjs.com/package/@leanandmean/scramjet) instead.\n\n---\n\nScramjet is a minimal terminal coding harness. Adapt scramjet to your workflows, not the other way around, without having to fork and modify internals. Extend it with TypeScript [Extensions](#extensions), [Skills](#skills), [Prompt Templates](#prompt-templates), and [Themes](#themes). Put your extensions, skills, prompt templates, and themes in [Scramjet Packages](#scramjet-packages) and share them with others via npm or git.\n\nScramjet ships with powerful defaults but skips features like sub agents and plan mode. Instead, you can ask scramjet to build what you want or install a third party package that matches your workflow.\n\nScramjet runs in four modes: interactive, print or JSON, RPC for process integration, and an SDK for embedding in your own apps.\n\n## Table of Contents\n\n- [Quick Start](#quick-start)\n- [Providers & Models](#providers--models)\n- [Interactive Mode](#interactive-mode)\n - [Editor](#editor)\n - [Commands](#commands)\n - [Keyboard Shortcuts](#keyboard-shortcuts)\n - [Message Queue](#message-queue)\n- [Sessions](#sessions)\n - [Branching](#branching)\n - [Compaction](#compaction)\n- [Settings](#settings)\n- [Context Files](#context-files)\n- [Customization](#customization)\n - [Prompt Templates](#prompt-templates)\n - [Skills](#skills)\n - [Extensions](#extensions)\n - [Themes](#themes)\n - [Scramjet Packages](#scramjet-packages)\n- [Programmatic Usage](#programmatic-usage)\n- [Philosophy](#philosophy)\n- [CLI Reference](#cli-reference)\n\n---\n\n## Quick Start\n\n```bash\nnpm install -g @leanandmean/scramjet\n```\n\nAuthenticate with an API key:\n\n```bash\nexport ANTHROPIC_API_KEY=sk-ant-...\nscramjet\n```\n\nOr use your existing subscription:\n\n```bash\nscramjet\n/login # Then select provider\n```\n\nThen just talk to scramjet. By default, scramjet gives the model four tools: `read`, `write`, `edit`, and `bash`. The model uses these to fulfill your requests. Add capabilities via [skills](#skills), [prompt templates](#prompt-templates), [extensions](#extensions), or [scramjet packages](#scramjet-packages).\n\n**Platform notes:** [Windows](docs/windows.md) | [Termux (Android)](docs/termux.md) | [tmux](docs/tmux.md) | [Terminal setup](docs/terminal-setup.md) | [Shell aliases](docs/shell-aliases.md)\n\n---\n\n## Providers & Models\n\nFor each built-in provider, scramjet 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).\n\n**Subscriptions:**\n- Anthropic Claude Pro/Max\n- OpenAI ChatGPT Plus/Pro (Codex)\n- GitHub Copilot\n\n**API keys:**\n- Anthropic\n- OpenAI\n- Azure OpenAI\n- DeepSeek\n- Google Gemini\n- Google Vertex\n- Amazon Bedrock\n- Mistral\n- Groq\n- Cerebras\n- Cloudflare AI Gateway\n- Cloudflare Workers AI\n- xAI\n- OpenRouter\n- Vercel AI Gateway\n- ZAI\n- OpenCode Zen\n- OpenCode Go\n- Hugging Face\n- Fireworks\n- Together AI\n- Kimi For Coding\n- MiniMax\n- Xiaomi MiMo\n- Xiaomi MiMo Token Plan (China)\n- Xiaomi MiMo Token Plan (Amsterdam)\n- Xiaomi MiMo Token Plan (Singapore)\n\nSee [docs/providers.md](docs/providers.md) for detailed setup instructions.\n\n**Custom providers & models:** Add providers via `~/.scramjet/agent/models.json` if they speak a supported API (OpenAI, Anthropic, Google). For custom APIs or OAuth, use extensions. See [docs/models.md](docs/models.md) and [docs/custom-provider.md](docs/custom-provider.md).\n\n---\n\n## Interactive Mode\n\n
\n\nThe interface from top to bottom:\n\n- **Startup header** - Shows shortcuts (`/hotkeys` for all), loaded AGENTS.md files, prompt templates, skills, and extensions\n- **Messages** - Your messages, assistant responses, tool calls and results, notifications, errors, and extension UI\n- **Editor** - Where you type; border color indicates thinking level\n- **Footer** - Working directory, session name, total token/cache usage, cost, context usage, current model, and recent median output speed\n\nThe default footer's existing dollar amount combines parent assistant costs across the whole journal with tool-reported costs, including nested subagents and failed/interrupted work. Cumulative tool updates replace earlier reports live; saved final costs survive resume. Recoverable legacy details are interpreted by the registered tool without rewriting history or enabling execution. Token/cache/context metrics remain parent-only; `/session`, RPC statistics, and custom footer examples retain their existing accounting.\n\nThe 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](#extensions) can also replace the editor, add widgets above/below it, a status line, custom footer, or overlays.\n\n### Browsing and copying output\n\nInteractive mode retains the current transcript in an application-managed viewport, including running tool cards. Use the mouse wheel/trackpad or drag the **rightmost Scramjet scrollbar** to inspect offscreen output before a turn finishes. New output preserves your reading position; returning to the bottom resumes following. The editor, adjacent widgets and footer stay docked by default, so you can type while reading older output. `/settings` offers live docking, maximum input-height percentage and wheel-step controls; undocking restores the single scrolling layout without changing renderer.\n\nWhile content remains below the viewport, the existing gap above the dock shows `Session: N lines below · Ctrl+End: latest`; the row stays blank at the tail. This counts rendered session rows, not unread messages or hidden draft text, and does not add another editor border. Narrow terminals shorten the hint and finally show `Session ↓…` if the labelled exact count cannot fit. The indicator is decorative and excluded from application copying.\n\nDrag without modifiers to select displayed text, including across scrolling; double-click selects a word and triple-click selects one displayed line. Right-click the selection or press Ctrl+C to copy it; built-in text rendering omits known layout padding and rejoins soft wraps while preserving genuine indentation and hard breaks. Selection stays live as output changes, and Copy captures the last displayed highlight immediately. Dragging can cross between transcript and editor; a downward transcript drag reaches the transcript bottom before entering the dock. Editor copying also rejoins soft wraps. Without selection, Ctrl+C retains its normal editor/quit behavior, and right-clicking the transcript, blank space, or editor pastes local clipboard text into the visible, focused editor without submitting it. Selectors and overlays do not paste. Terminal-native Copy menus cannot see application selection.\n\nHome/End always retain editor line-start/end behavior. Ctrl+Home/Ctrl+End navigate to the transcript beginning/bottom, with Ctrl+End resuming following. Submitting nonempty editor input resumes following immediately, including `!`/`!!` commands, slash commands and queued messages. A new user message appearing in the transcript also resumes following. While scrolled away, PageUp/PageDown browse and Escape returns to the live tail; Alt+PageUp/Alt+PageDown enter browsing from the tail. Docked editing and presentation toggles preserve the reading position; undocked editing reveals its cursor. At the tail, ordinary editor/list bindings apply. Hidden approval controls must first be revealed before a subsequent activation can approve.\n\nBy default, orderly exit restores the shell without printing a transcript. Enable **Retain transcript on exit** in `/settings` to leave the full current styled history, widgets, rendered editor and footer in terminal scrollback; collapsed content stays collapsed and images become labelled placeholders. Suspension and external-editor handoffs never dump history. Saved sessions and `/export` remain available. See [terminal setup](docs/terminal-setup.md#transcript-browsing-and-copying) for tested configurations, iTerm2's required right-click setting, clipboard limits and image behavior.\n\n### Editor\n\n| Feature | How |\n|---------|-----|\n| File reference | Type `@` to fuzzy-search project files |\n| Path completion | Tab to complete paths |\n| Multi-line | Shift+Enter (or Ctrl+Enter on Windows Terminal) |\n| Images | Ctrl+V to paste (Alt+V on Windows), or drag onto terminal |\n| Bash commands | `!command` runs and sends output to LLM, `!!command` runs without sending |\n\nStandard editing keybindings for delete word, undo, etc. See [docs/keybindings.md](docs/keybindings.md).\n\n### Commands\n\nType `/` in the editor to trigger commands. [Extensions](#extensions) can register custom commands, [skills](#skills) are available as `/skill:name`, and [prompt templates](#prompt-templates) expand via `/templatename`.\n\n| Command | Description |\n|---------|-------------|\n| `/login`, `/logout` | OAuth authentication |\n| `/model` | Switch models |\n| `/scoped-models` | Enable/disable models for Ctrl+P cycling |\n| `/settings` | Thinking level, theme, message delivery, transport |\n| `/resume` | Pick from previous sessions |\n| `/new` | Start a new session |\n| `/name ` | Set session display name |\n| `/session` | Show session info (file, ID, messages, tokens, cost) |\n| `/tree` | Jump to any point in the session and continue from there |\n| `/fork` | Create a new session from a previous user message |\n| `/clone` | Duplicate the current active branch into a new session |\n| `/compact [prompt]` | Manually compact context, optional custom instructions |\n| `/copy` | Copy last assistant message to clipboard |\n| `/export [file]` | Export session to HTML file |\n| `/share` | Upload as private GitHub gist with shareable HTML link |\n| `/reload` | Reload keybindings, extensions, skills, prompts, and context files (themes hot-reload automatically) |\n| `/hotkeys` | Show all keyboard shortcuts |\n| `/changelog` | Display version history |\n| `/quit` | Quit scramjet |\n\n### Keyboard Shortcuts\n\nSee `/hotkeys` for the full list. Customize via `~/.scramjet/agent/keybindings.json`. See [docs/keybindings.md](docs/keybindings.md).\n\n**Commonly used:**\n\n| Key | Action |\n|-----|--------|\n| Ctrl+C | Copy transcript selection; otherwise clear editor |\n| Ctrl+C twice | Quit |\n| Escape | Return from transcript browsing; otherwise cancel/abort |\n| Escape twice | Open `/tree` |\n| Ctrl+L | Open model selector |\n| Ctrl+P / Shift+Ctrl+P | Cycle scoped models forward/backward |\n| Shift+Tab | Cycle thinking level |\n| Ctrl+O | Collapse/expand tool output |\n| Ctrl+T | Collapse/expand thinking blocks |\n\n### Message Queue\n\nSubmit messages while the agent is working:\n\n- **Enter** queues a *steering* message, delivered after the current assistant turn finishes executing its tool calls\n- **Alt+Enter** queues a *follow-up* message, delivered only after the agent finishes all work\n- **Escape** aborts and restores queued messages to editor\n- **Alt+Up** retrieves queued messages back to editor\n\nOn Windows Terminal, `Alt+Enter` is fullscreen by default. Remap it in [docs/terminal-setup.md](docs/terminal-setup.md) so scramjet can receive the follow-up shortcut.\n\nConfigure delivery in [settings](docs/settings.md): `steeringMode` defaults to `\"all\"` (delivers all queued at once), while `followUpMode` defaults to `\"one-at-a-time\"` (waits for a response). Both settings accept either value. `transport` selects provider transport preference (`\"sse\"`, `\"websocket\"`, or `\"auto\"`) for providers that support multiple transports.\n\n---\n\n## Sessions\n\nSessions 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](docs/session-format.md) for file format.\n\n### Management\n\nSessions auto-save to `~/.scramjet/agent/sessions/` organized by working directory.\n\n```bash\nscramjet -c # Continue most recent session\nscramjet -r # Browse and select from past sessions\nscramjet --no-session # Ephemeral mode (don't save)\nscramjet --session # Use specific session file or ID\nscramjet --fork # Fork specific session file or ID into a new session\n```\n\nUse `/session` in interactive mode to see the current session ID before reusing it with `--session ` or `--fork `.\n\n### Branching\n\n**`/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.\n\n
\n\n- Search by typing, fold/unfold and jump between branches with Ctrl+←/Ctrl+→ or Alt+←/Alt+→, page with ←/→\n- Filter modes (Ctrl+O): default → no-tools → user-only → labeled-only → all\n- Press Shift+L to label entries as bookmarks and Shift+T to toggle label timestamps\n\n**`/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.\n\n**`/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.\n\n**`--fork `** - 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.\n\n### Compaction\n\nLong sessions can exhaust context windows. Compaction summarizes older messages while keeping recent ones.\n\n**Manual:** `/compact` or `/compact `\n\n**Automatic:** Enabled by default. Triggers on context overflow (recovers and retries) or when approaching the limit (proactive). Configure via `/settings` or `settings.json`.\n\nCompaction is lossy. The full history remains in the JSONL file; use `/tree` to revisit. Customize compaction behavior via [extensions](#extensions). See [docs/compaction.md](docs/compaction.md) for internals.\n\n---\n\n## Settings\n\nUse `/settings` to modify common options, or edit JSON files directly:\n\n| Location | Scope |\n|----------|-------|\n| `~/.scramjet/agent/settings.json` | Global (all projects) |\n| `.scramjet/settings.json` | Project (overrides global) |\n\nSee [docs/settings.md](docs/settings.md) for all options.\n\n### Telemetry and update checks\n\nThe runtime inherits two startup features from the upstream Pi codebase:\n\n- **Update check:** disabled by the Scramjet binary (`PI_SKIP_VERSION_CHECK=1` is set automatically). The upstream check against `pi.dev` never runs.\n- **Install/update telemetry:** after first install or a changelog-detected update, sends an anonymous version ping to `https://pi.dev/api/report-install`. Opt out by setting `enableInstallTelemetry` to `false` in `settings.json`, or by setting `PI_TELEMETRY=0`.\n\nUse `--offline` or `PI_OFFLINE=1` to disable all startup network operations, including package update checks and install/update telemetry.\n\n---\n\n## Context Files\n\nScramjet loads `CLAUDE.md` and `AGENTS.md` at startup from:\n- `~/.scramjet/agent/` (global)\n- Parent directories (walking up from cwd)\n- Current directory\n\nUse them for project instructions, conventions, and common commands. Files load broadest-to-most-specific, with `CLAUDE.md` before `AGENTS.md` in each directory. When both names in one directory decode to exactly equal text, only `CLAUDE.md` is loaded; identical text in different directories remains independently loaded.\n\nDisable context file loading with `--no-context-files` (or `-nc`).\n\n### System Prompt\n\nReplace the default system prompt with `.scramjet/SYSTEM.md` (project) or `~/.scramjet/agent/SYSTEM.md` (global). Append without replacing via `APPEND_SYSTEM.md`.\n\n---\n\n## Customization\n\n### Prompt Templates\n\nReusable prompts as Markdown files. Type `/name` to expand.\n\n```markdown\n\nReview this code for bugs, security issues, and performance problems.\nFocus on: {{focus}}\n```\n\nPlace in `~/.scramjet/agent/prompts/`, `.scramjet/prompts/`, or a [scramjet package](#scramjet-packages) to share with others. See [docs/prompt-templates.md](docs/prompt-templates.md).\n\n### Skills\n\nOn-demand capability packages following the [Agent Skills standard](https://agentskills.io). Invoke via `/skill:name` or let the agent load them automatically.\n\n```markdown\n\n# My Skill\nUse this skill when the user asks about X.\n\n## Steps\n1. Do this\n2. Then that\n```\n\nPlace in `~/.scramjet/agent/skills/`, `~/.agents/skills/`, `.scramjet/skills/`, or `.agents/skills/` (from `cwd` up through parent directories) or a [scramjet package](#scramjet-packages) to share with others. See [docs/skills.md](docs/skills.md).\n\n### Extensions\n\n
\n\nTypeScript modules that extend scramjet with custom tools, commands, keyboard shortcuts, event handlers, and UI components.\n\n```typescript\nexport default function (pi: ExtensionAPI) {\n pi.registerTool({ name: \"deploy\", ... });\n pi.registerCommand(\"stats\", { ... });\n pi.on(\"tool_call\", async (event, ctx) => { ... });\n}\n```\n\nThe default export can also be `async`. Scramjet waits for async extension factories before startup continues, which is useful for one-time initialization such as fetching remote model lists before calling `pi.registerProvider()`.\n\n**What's possible:**\n- Custom tools (or replace built-in tools entirely)\n- Sub-agents and plan mode\n- Custom compaction and summarization\n- Permission gates and path protection\n- Custom editors and UI components\n- Status lines, headers, footers\n- Git checkpointing and auto-commit\n- SSH and sandbox execution\n- MCP server integration\n- Games while waiting (yes, Doom runs)\n- ...anything you can dream up\n\nPlace in `~/.scramjet/agent/extensions/`, `.scramjet/extensions/`, or a [scramjet package](#scramjet-packages) to share with others. See [docs/extensions.md](docs/extensions.md) and [examples/extensions/](examples/extensions/).\n\n### Themes\n\nBuilt-in: `scramjet-dark` (the bundled default for dark-mode terminals), plus Pi's original `pi-dark` and `pi-light`. Themes hot-reload: modify the active theme file and scramjet immediately applies changes.\n\nPlace in `~/.scramjet/agent/themes/`, `.scramjet/themes/`, or a [scramjet package](#scramjet-packages) to share with others. See [docs/themes.md](docs/themes.md).\n\n### Scramjet Packages\n\nBundle and share extensions, skills, prompts, and themes via npm or git. Find packages on [npmjs.com](https://www.npmjs.com/search?q=keywords%3Api-package).\n\n> **Security:** Scramjet 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.\n\n```bash\nscramjet install npm:@foo/pi-tools\nscramjet install npm:@foo/pi-tools@1.2.3 # pinned version\nscramjet install git:github.com/user/repo\nscramjet install git:github.com/user/repo@v1 # tag or commit\nscramjet install git:git@github.com:user/repo\nscramjet install git:git@github.com:user/repo@v1 # tag or commit\nscramjet install https://github.com/user/repo\nscramjet install https://github.com/user/repo@v1 # tag or commit\nscramjet install ssh://git@github.com/user/repo\nscramjet install ssh://git@github.com/user/repo@v1 # tag or commit\nscramjet remove npm:@foo/pi-tools\nscramjet uninstall npm:@foo/pi-tools # alias for remove\nscramjet list\nscramjet update # update the CLI and packages (skips pinned packages)\nscramjet update --extensions # update packages only\nscramjet update --self # update the CLI only\nscramjet update --self --force # reinstall the CLI even if current\nscramjet update npm:@foo/pi-tools # update one package\nscramjet config # enable/disable extensions, skills, prompts, themes\n```\n\nPackages install to `~/.scramjet/agent/git/` (git) or global npm. Use `-l` for project-local installs (`.scramjet/git/`, `.scramjet/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\"]`.\n\nCreate a package by adding a `pi` key to `package.json`:\n\n```json\n{\n \"name\": \"my-scramjet-package\",\n \"keywords\": [\"pi-package\"],\n \"pi\": {\n \"extensions\": [\"./extensions\"],\n \"skills\": [\"./skills\"],\n \"prompts\": [\"./prompts\"],\n \"themes\": [\"./themes\"]\n }\n}\n```\n\nWithout a `pi` manifest, scramjet auto-discovers from conventional directories (`extensions/`, `skills/`, `prompts/`, `themes/`).\n\nSee [docs/packages.md](docs/packages.md).\n\n---\n\n## Programmatic Usage\n\n### SDK\n\n```typescript\nimport { AuthStorage, createAgentSession, ModelRegistry, SessionManager } from \"@leanandmean/coding-agent\";\n\nconst authStorage = AuthStorage.create();\nconst modelRegistry = ModelRegistry.create(authStorage);\nconst { session } = await createAgentSession({\n sessionManager: SessionManager.inMemory(),\n authStorage,\n modelRegistry,\n});\n\nawait session.prompt(\"What files are in the current directory?\");\n```\n\nFor advanced multi-session runtime replacement, use `createAgentSessionRuntime()` and `AgentSessionRuntime`.\n\nSee [docs/sdk.md](docs/sdk.md) and [examples/sdk/](examples/sdk/).\n\n### RPC Mode\n\nFor non-Node.js integrations, use RPC mode over stdin/stdout:\n\n```bash\nscramjet --mode rpc\n```\n\nRPC 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.\n\nSee [docs/rpc.md](docs/rpc.md) for the protocol.\n\n---\n\n## Philosophy\n\nScramjet is aggressively extensible so it doesn't have to dictate your workflow. Features that other tools bake in can be built with [extensions](#extensions), [skills](#skills), or installed from third-party [scramjet packages](#scramjet-packages). This keeps the core minimal while letting you shape scramjet to fit how you work.\n\n**No MCP.** Build CLI tools with READMEs (see [Skills](#skills)), or build an extension that adds MCP support. [Why?](https://mariozechner.at/posts/2025-11-02-what-if-you-dont-need-mcp/)\n\n**No sub-agents.** There's many ways to do this. Spawn scramjet instances via tmux, or build your own with [extensions](#extensions), or install a package that does it your way.\n\n**No permission popups.** Run in a container, or build your own confirmation flow with [extensions](#extensions) inline with your environment and security requirements.\n\n**No plan mode.** Write plans to files, or build it with [extensions](#extensions), or install a package.\n\n**No built-in to-dos.** They confuse models. Use a TODO.md file, or build your own with [extensions](#extensions).\n\n**No background bash.** Use tmux. Full observability, direct interaction.\n\n---\n\n## CLI Reference\n\n```bash\nscramjet [options] [@files...] [messages...]\n```\n\n### Package Commands\n\n```bash\nscramjet install [-l] # Install package, -l for project-local\nscramjet remove [-l] # Remove package\nscramjet uninstall [-l] # Alias for remove\nscramjet update [source|self] # Update the CLI and packages (skips pinned packages)\nscramjet update --extensions # Update packages only\nscramjet update --self # Update the CLI only\nscramjet update --self --force # Reinstall the CLI even if current\nscramjet update --extension # Update one package\nscramjet list # List installed packages\nscramjet config # Enable/disable package resources\n```\n\n### Modes\n\n| Flag | Description |\n|------|-------------|\n| (default) | Interactive mode |\n| `-p`, `--print` | Print response and exit |\n| `--mode json` | Output all events as JSON lines (see [docs/json.md](docs/json.md)) |\n| `--mode rpc` | RPC mode for process integration (see [docs/rpc.md](docs/rpc.md)) |\n| `--export [out]` | Export session to HTML |\n\nIn print mode, scramjet also reads piped stdin and merges it into the initial prompt:\n\n```bash\ncat README.md | scramjet -p \"Summarize this text\"\n```\n\n### Model Options\n\n| Option | Description |\n|--------|-------------|\n| `--provider ` | Provider (anthropic, openai, google, etc.) |\n| `--model ` | Model pattern or ID (supports `provider/id` and optional `:`) |\n| `--api-key ` | API key (overrides env vars) |\n| `--thinking ` | `off`, `minimal`, `low`, `medium`, `high`, `xhigh` |\n| `--models ` | Comma-separated patterns for Ctrl+P cycling |\n| `--list-models [search]` | List available models |\n\n### Session Options\n\n| Option | Description |\n|--------|-------------|\n| `-c`, `--continue` | Continue most recent session |\n| `-r`, `--resume` | Browse and select session |\n| `--session ` | Use specific session file or partial UUID |\n| `--fork ` | Fork specific session file or partial UUID into a new session |\n| `--session-dir ` | Custom session storage directory |\n| `--no-session` | Ephemeral mode (don't save) |\n\n### Tool Options\n\n| Option | Description |\n|--------|-------------|\n| `--tools `, `-t ` | Allowlist specific tool names across built-in, extension, and custom tools |\n| `--no-builtin-tools`, `-nbt` | Disable built-in tools by default but keep extension/custom tools enabled |\n| `--no-tools`, `-nt` | Disable all tools by default |\n\nAvailable built-in tools: `read`, `bash`, `edit`, `write`, `grep`, `find`, `ls`\n\n### Resource Options\n\n| Option | Description |\n|--------|-------------|\n| `-e`, `--extension ` | Load extension from path, npm, or git (repeatable) |\n| `--no-extensions` | Disable extension discovery |\n| `--skill ` | Load skill (repeatable) |\n| `--no-skills` | Disable skill discovery |\n| `--prompt-template ` | Load prompt template (repeatable) |\n| `--no-prompt-templates` | Disable prompt template discovery |\n| `--theme ` | Load theme (repeatable) |\n| `--no-themes` | Disable theme discovery |\n| `--no-context-files`, `-nc` | Disable AGENTS.md and CLAUDE.md context file discovery |\n\nCombine `--no-*` with explicit flags to load exactly what you need, ignoring settings.json (e.g., `--no-extensions -e ./my-ext.ts`).\n\n### Other Options\n\n| Option | Description |\n|--------|-------------|\n| `--system-prompt ` | Replace default prompt (context files and skills still appended) |\n| `--append-system-prompt ` | Append to system prompt |\n| `--verbose` | Force verbose startup |\n| `-h`, `--help` | Show help |\n| `-v`, `--version` | Show version |\n\n### File Arguments\n\nPrefix files with `@` to include in the message:\n\n```bash\nscramjet @prompt.md \"Answer this\"\nscramjet -p @screenshot.png \"What's in this image?\"\nscramjet @code.ts @test.ts \"Review these files\"\n```\n\n### Examples\n\n```bash\n# Interactive with initial prompt\nscramjet \"List all .ts files in src/\"\n\n# Non-interactive\nscramjet -p \"Summarize this codebase\"\n\n# Non-interactive with piped stdin\ncat README.md | scramjet -p \"Summarize this text\"\n\n# Different model\nscramjet --provider openai --model gpt-4o \"Help me refactor\"\n\n# Model with provider prefix (no --provider needed)\nscramjet --model openai/gpt-4o \"Help me refactor\"\n\n# Model with thinking level shorthand\nscramjet --model sonnet:high \"Solve this complex problem\"\n\n# Limit model cycling\nscramjet --models \"claude-*,gpt-4o\"\n\n# Read-only mode\nscramjet --tools read,grep,find,ls -p \"Review the code\"\n\n# High thinking level\nscramjet --thinking high \"Solve this complex problem\"\n```\n\n### Environment Variables\n\n| Variable | Description |\n|----------|-------------|\n| `SCRAMJET_CODING_AGENT_DIR` | Override config directory (default: `~/.scramjet/agent`). Legacy `PI_CODING_AGENT_DIR` is also accepted |\n| `SCRAMJET_CODING_AGENT_SESSION_DIR` | Override session storage directory (overridden by `--session-dir`). Legacy `PI_CODING_AGENT_SESSION_DIR` is also accepted |\n| `PI_PACKAGE_DIR` | Override package directory (useful for Nix/Guix where store paths tokenize poorly) |\n| `PI_OFFLINE` | Disable startup network operations, including package update checks and install/update telemetry |\n| `PI_TELEMETRY` | Override install/update telemetry. Use `1`/`true`/`yes` to enable or `0`/`false`/`no` to disable |\n| `PI_CACHE_RETENTION` | Set to `long` for extended prompt cache (Anthropic: 1h, OpenAI: 24h) |\n| `VISUAL`, `EDITOR` | External editor for Ctrl+G |\n\nThe `PI_*` variable names are inherited from the upstream runtime. `SCRAMJET_CODING_AGENT_DIR` and `SCRAMJET_CODING_AGENT_SESSION_DIR` are the canonical names; the Scramjet binary bridges legacy `PI_CODING_AGENT_DIR` / `PI_CODING_AGENT_SESSION_DIR` for backward compatibility.\n\nThe upstream `PI_SKIP_VERSION_CHECK` is set automatically by the Scramjet binary — the pi.dev version check never runs.\n\n---\n\n## Contributing & Development\n\nSee [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines and [docs/development.md](docs/development.md) for setup, forking, and debugging.\n\n---\n\n## License\n\nApache-2.0\n\n## See Also\n\n- [@leanandmean/ai](https://www.npmjs.com/package/@leanandmean/ai): Core LLM toolkit\n- [@leanandmean/agent](https://www.npmjs.com/package/@leanandmean/agent): Agent framework\n- [@leanandmean/tui](https://www.npmjs.com/package/@leanandmean/tui): Terminal UI components\n","readmeFilename":"README.md"}
![\"GitHub\"](\"https://img.shields.io/badge/github-LeanAndMean%2Fscramjet-181717?style=flat-square&logo=github\"){kind=icon}
\n ![\"npm\"](\"https://img.shields.io/npm/v/@leanandmean/scramjet?style=flat-square\")
\n![\"Interactive](\"docs/images/interactive-mode.png\")
![\"Tree](\"docs/images/tree-view.png\")
![\"Doom](\"docs/images/doom-extension.png\")