octomux: Instructions file for Claude Code

CLAUDE.md

octomux CLAUDE.md is an instructions file for Claude Code from ShreyPaharia/octomux. It costs 11,253 tokens per session, scanned A, original, MIT.

A `CLAUDE.md` instruction set for Octomux, a tool that coordinates Claude Code and Cursor agents from a web dashboard.

In plain words
What is it for?
Use it when developing Octomux, including its Bun, React, Express, SQLite, terminal, WebSocket, worktree, and tmux components.
Why use it?
It records the project's required technology choices, commands, architecture, storage locations, and isolation rules so agents make compatible changes.

Instructions file for Claude Code

Written for Claude Code: Claude Code plugin machinery. Also seen: reads .claude/ paths; mentions CLAUDE.md; mentions subagents.

This is ShreyPaharia/octomux's own configuration. It tells Claude Code how to work on octomux itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything octomux configures →

Reuse

Borrowing it

Nothing to install: this file belongs to ShreyPaharia/octomux. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/ShreyPaharia/octomux/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/ShreyPaharia/octomux

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for octomux CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/shreypaharia/octomux/claude-md/github.svg)](https://agentmods.dev/instructions/shreypaharia/octomux/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/shreypaharia/octomux/claude-md"><img src="https://agentmods.dev/badge/instructions/shreypaharia/octomux/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for octomux CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/shreypaharia/octomux/claude-md"><img src="https://agentmods.dev/badge/instructions/shreypaharia/octomux/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 11,253 This file is loaded in full into every session.
When invoked 11,253 The same file — it is already loaded in full.
Security scan A 1 finding. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.11253 $0.11253
Opus 5 $0.05627 $0.05627
Sonnet 5 $0.02251 $0.02251
Haiku 4.5 $0.01125 $0.01125

Measured 11d ago against content hash 661d51ddde6f, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-11, from the pricing page.

Security

Grade A, and why

octomux CLAUDE.md scanned grade A with 1 finding against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 11d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Runs shell commandslowCapability

Expected in a hook, worth knowing in a rule or an instructions file.

- **Mock order matters** when a factory loads real modules: mock `child_process`
CLAUDE.md · 611 lines

How it starts

The opening of the file, as written. The whole thing — 611 lines — stays where its author put it; the contents beside it link to each section on GitHub.

octomux

npm package (octomux) for orchestrating autonomous Claude Code and Cursor agents from a web dashboard. Single binary: octomux <command>. Data stored at ~/.octomux/ in production, ./data/ in development (NODE_ENV !== 'production'); override the production root with OCTOMUX_DATA_DIR (the Electron app sets this to an app-private path).

Tech Stack

  • Frontend: Vite + React 19 + Tailwind CSS 4 + shadcn/ui + React Router 7
  • Backend: Express 5 + bun:sqlite (WAL mode) + Bun.Terminal + ws
  • Terminal: xterm.js (bidirectional) → Bun.Terminal (server/pty.ts) → tmux attach
  • Isolation: git worktrees per task, tmux sessions per task, tmux windows per agent
  • IDs: nanoid(12)
  • Runtime: bun everywhere — package manager, script runner, dev server, test runner, and the compiler for the shipped binary. No Node in the build or at runtime. There is no better-sqlite3, node-pty, vitest, or tsup; do not reintroduce them.
  • Binary: bun build --compile bin/main.js → one self-contained executable per platform. start launches the dashboard, all other subcommands are CLI operations.

Commands

  • bun run dev — starts Express (7777) + Vite concurrently
  • bun run test — all three suites below
  • bun run test:serverserver/ + cli/review (bun test)
  • bun run test:clientsrc/ (bun test + happy-dom preload)
  • bun run test:unitscli/src, packages, bin (bun test)
  • bun run test:watch — bun test in watch mode (server suite)
  • bun run test:e2e — Playwright E2E tests (auto-starts servers)
  • bun run test:e2e:ui — Playwright interactive UI mode
  • bun run bench:task-create [-- --repo <path> --runs N] — times real startTask runs and prints a per-stage breakdown (reads the stage_timing log lines)
  • bun run lint / bun run lint:fix — ESLint 9 flat config
  • bun run format / bun run format:check — Prettier
  • bun run typechecktsc -b (project references across packages/*)
  • bun run build — builds packages/* (diff-engine, types, test-fixtures, api-client, capabilities), then the compiled binary
  • bun run build:binary — this host only → dist-bin/octomux
  • bun run build:binary:all — all six targets
  • bun run build:npm — build all + sign + stage dist-npm/ for publishing

Read the full file on GitHub · 611 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 11d ago First seen · 611 lines · 11,253 tokens per session scan A 661d51ddde6f

Subscribe to this mod's changes

octomux CLAUDE.md is an instructions file published in the GitHub repository ShreyPaharia/octomux (22 stars, last pushed 10d ago), licensed MIT. It adds 11,253 tokens to every session, about $0.0563 per session on Opus 5. A static security scan graded it A with 1 finding (runs shell commands). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,153 tokens

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens