Pixel Agents is a visual interface that represents AI coding agents working in terminals as animated pixel-art characters in a virtual office. Developers use it through a VS Code extension or a standalone browser-based CLI interface to observe agent activity and waiting states.
Borrowing it
Nothing to install: this file belongs to pixel-agents-hq/pixel-agents. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.
curl -O https://raw.githubusercontent.com/pixel-agents-hq/pixel-agents/main/CLAUDE.mdgit clone --depth 1 https://github.com/pixel-agents-hq/pixel-agentsWrote 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.
[](https://agentmods.dev/instructions/pixel-agents-hq/pixel-agents/claude-md)<a href="https://agentmods.dev/instructions/pixel-agents-hq/pixel-agents/claude-md"><img src="https://agentmods.dev/badge/instructions/pixel-agents-hq/pixel-agents/claude-md.svg" alt="Measured on agentmods" height="20"></a>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.
| Model | Per session | Once invoked |
|---|---|---|
| Fable 5.1 | $0.15023 | $0.15023 |
| Opus 5 | $0.07512 | $0.07512 |
| Sonnet 5 | $0.03005 | $0.03005 |
| Haiku 4.5 | $0.01502 | $0.01502 |
Grade B, and why
pixel-agents CLAUDE.md scanned grade B 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 7d 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.
Reads agent configuration directoriesmediumAgent snooping
.claude/, .codex/, .gemini/ hold keys, settings and other credentials a mod has no legitimate need for.
claudeHookInstaller.ts Consent-gated install/uninstall in ~/.claude/settings.json (abort on unparseable file or non-array hooks.<Event>; one-time .pixel-agents.backup, exclusive-create, no backup ⇒ no write — but skipped How it starts
The opening of the file, as written. The whole thing — 650 lines — stays where its author put it; the contents beside it link to each section on GitHub.
Pixel Agents — Compressed Reference
Pixel art office where AI agents (Claude Code terminals today, any tool tomorrow) become animated characters. Ships as a VS Code extension and an npx pixel-agents standalone CLI from the same source tree.
CONTEXT.md is the canonical glossary — read it for what terms like Agent, Sub-agent, Teammate, Lead, Adopt, or Headless agent mean here, and use its vocabulary in code, comments, and docs.
Architecture
Strict layering: core/ depends on nothing; server/ depends only on core/; webview-ui/ depends only on core/; adapters/vscode/ depends on core/ and server/. The standalone CLI never imports adapters/vscode/ and vice versa.
core/ Protocol + interface definitions (zero runtime side effects)
asyncapi.yaml AsyncAPI 3.0 contract — single source of truth
src/
messages.ts AUTO-GENERATED discriminated unions (do not edit)
schemas.ts AgentMeta, SpriteData, FurnitureCatalogEntry
provider.ts HookProvider, AgentEvent (the integration boundary)
teamProvider.ts Optional TeamProvider (semantic queries for Lead + Teammates)
transport.ts MessageTransport interface, TransportState
adapter.ts StateAdapter, AssetCache, PersistedAgent, AgentSeat
terminalAdapter.ts TerminalAdapter (editor-driven terminal management)
normalizeProjectPath.ts
constants.ts
server/ Lifecycle runtime + Fastify HTTP/WS server
src/
providers/hook/claude/ Reference HookProvider — only place that knows Claude specifics
claude.ts normalizeHookEvent for 11 Claude events, formatToolStatus, file fallback
claudeTeamProvider.ts TeamProvider: reads ~/.claude/teams/<name>/config.json
claudeHookInstaller.ts Consent-gated install/uninstall in ~/.claude/settings.json (abort on unparseable file or non-array hooks.<Event>; one-time .pixel-agents.backup, exclusive-create, no backup ⇒ no write — but skipped when the replaced content is entirely our own install's output, since backing up our own file masquerades as the user's original (`settingsHoldOnlyOurHooks`, compared against makeHookEntry — the WRITER — so a field added to what we write can't silently revive the bug; only `command`/`timeout` may differ, they vary across installs); every write failure THROWS; mode preserved, 0600 on create; re-read verify immediately before rename + retry; hook identity = `/.pixel-agents/hooks/claude-hook.js` suffix anchored at both ends of the command's first token, case-insensitive; `areHooksInstalled` = ANY of our commands on ANY event)
consentCopy.ts Claude's first-run consent disclosure text (scope/data/undo), served through consentDisclosure()
constants.ts Claude hook event names, script path
hooks/claude-hook.ts Hook script (CJS+shebang, bundled to dist/hooks/claude-hook.js)
providers/hook/consentGate.ts Provider-agnostic consent POLICY: when to ask (hooksConsentRequest per provider) and what an answer means (consentActionFor(choice, {installed, consent}) — see docs/adr/0001)
providers/hook/consentExecutor.ts Provider-agnostic consent EXECUTION: applyConsentChoice(providerId, choice, ConsentEffects) runs the six actions in one order for both surfaces, and SERIALIZES answers per process across ALL providers
providers/index.ts Provider registry (claudeProvider + the hookProviders list the consent gate loops over)
agentRuntime.ts Lifecycle core: timers, scanners, HookEventHandler, SessionRouter, DismissalTracker
agentStateStore.ts EventEmitter-backed single source of truth (typed mutations + events)
sessionRouter.ts session_id → agent_id mapping, event buffering, pending external sessions
dismissalTracker.ts Unified dismissal state (replaces four legacy globals)
hookEventHandler.ts Dispatches normalized AgentEvent into runtime
httpServer.ts Fastify: POST /api/hooks/:providerId, GET /api/health, GET /ws, SPA (standalone)
clientMessageHandler.ts Single dispatch point for ClientMessage from webview
server.ts Top-level composition
cli.ts npx pixel-agents entry (npm bin)
fileStateAdapter.ts Namespaced ~/.pixel-agents/ persistence
configPersistence.ts { vscode, standalone, externalAssetDirectories, hooksConsent: {providerId: granted|declined}, hooksEnabled: {providerId: boolean} }
layoutPersistence.ts ~/.pixel-agents/layout.json with atomic tmp+rename
fileWatcher.ts Hybrid fs.watch + 500ms polling, JSONL line buffering, /clear detection
transcriptParser.ts JSONL parsing for heuristic / file-fallback mode
timerManager.ts Waiting / permission timers
assetLoader.ts PNG → SpriteData via pngjs
teamUtils.ts isInlineTeammateOf, getInlineTeammates, hasInlineTeammates
types.ts ServerAgentState
constants.ts All timing/scanning constants
__tests__/ 28 Vitest files
manual-hook-events.http Manual hook testing helper (REST-Client format)
adapters/vscode/ VS Code surface — composes core + server
extension.ts activate() / deactivate()
PixelAgentsViewProvider.ts WebviewViewProvider, thin bridge to AgentRuntime
agentManager.ts Terminal lifecycle (claude --session-id <uuid>), restore, persist
vscodeTerminalAdapter.ts TerminalAdapter implementation
uninstall.ts vscode:uninstall hook — removes hook entries + factory-resets hooks config after extension removal
migrateVsCodeState.ts One-time legacy state migration (verify-before-clear)
constants.ts VS Code IDs, command names, key names
webview-ui/ React 19 + Canvas UI (depends only on core/)
src/
transport/
index.ts createTransport() — single runtime branching point
postMessageTransport.ts VS Code mode (acquireVsCodeApi)
webSocketTransport.ts Standalone mode (exponential backoff, send queue)
types.ts Re-exports MessageTransport from core
runtime.ts isBrowserRuntime detection
browserMock.ts Standalone-browser asset fetch + message injection
testHooks.ts window globals exposed for e2e (officeState, helpers)
main.tsx React entry (StrictMode + createRoot)
App.tsx Composition root (hooks + components + EditActionBar)
constants.ts Webview magic numbers/strings
notificationSound.ts Web Audio API chime
changelogData.ts Changelog modal content
components/ React UI (toolbars, modals, settings)
BottomToolbar.tsx, ZoomControls.tsx, SettingsModal.tsx, InfoModal.tsx,
Tooltip.tsx, DebugView.tsx, ui/Button.tsx, ...
hooks/
useExtensionMessages.ts Message handler — translates ServerMessage into OfficeState mutations
useEditorActions.ts Editor state + callbacks
useEditorKeyboard.ts Keyboard shortcuts (R, T, Esc, Ctrl+Z/Y)
introTourState.ts Intro tour wire-state machine (pure reducer, Node-runner tested)
useIntroTour.ts Wires the reducer to React + transport (snapshot, verdict, choices)
office/
types.ts OfficeLayout, Character, etc. + re-exports constants
toolUtils.ts STATUS_TO_TOOL mapping, extractToolName (DOM-free; defaultZoom lives in useEditorActions)
projection.ts World→screen math shared by renderer + DOM overlays (mapOffset, overlayProjection)
colorize.ts Colorize (grayscale→HSL) + Adjust (HSL shift)
floorTiles.ts Floor sprite storage + colorized cache
wallTiles.ts Wall auto-tile: 16 bitmask sprites
sprites/
spriteData.ts Pixel data (characters, furniture, tiles, bubbles)
spriteCache.ts SpriteData → offscreen canvas, per-zoom WeakMap
editor/
editorActions.ts Pure layout ops
editorState.ts Imperative state (tools, ghost, selection, undo/redo, drag)
EditorToolbar.tsx
layout/
furnitureCatalog.ts Dynamic catalog from loaded assets
layoutSerializer.ts OfficeLayout ↔ runtime (tileMap, furniture, seats)
tileMap.ts Walkability, BFS pathfinding
engine/
characters.ts Character FSM (idle/walk/type) + wander AI
officeState.ts Game world (layout, characters, seats, selection, subagents, consent greeter)
gameLoop.ts rAF loop with delta-time cap (0.1 s)
renderer.ts Canvas: tiles, z-sorted entities, overlays, edit UI
matrixEffect.ts Spawn/despawn digital rain (drawing only)
matrixEffectState.ts Effect state: startMatrixEffect/advanceMatrixEffect (DOM-free)
components/
OfficeCanvas.tsx Canvas, resize, DPR, mouse hit-testing, drag-to-move
ToolOverlay.tsx Activity label above hovered/selected character
e2e/ Playwright suite (real VS Code + mock-claude scenarios)
playwright.config.ts
global-setup.ts
fixtures/
pixel-agents.ts VS Code fixture: launch Electron, wait for panel
standalone.ts Standalone CLI fixture: spawn server + browser page
mock-claude, mock-claude.cmd Bash + cmd wrapper invoked instead of real claude
mock-claude-runner.cjs Scenario runner: appendJsonl, emitHook, holdOpen
helpers/
launch.ts Electron app + isolated HOME/workspace
mock-claude.ts claudeScenario() builder
office.ts Overlay locators + assertions
webview.ts Settings/modal helpers
hooks.ts Hook server lifecycle helpers
standalone.ts Standalone server + WebSocket browser helpers
internal-agent.ts spawnInternalAgentAndWait
lifecycle.ts Reusable scenario fragments
team.ts Team config seeding + teammate helpers
allure-labels.ts @area:<tag> → Allure epic
tests/
claude/hooks-on/ basic.spec.ts, lifecycle.spec.ts, teams.spec.ts
claude/hooks-off/ lifecycle.spec.ts, matrix.spec.ts
standalone/ hooks.spec.ts
README.md Auto-generated test inventory (regen via npm run e2e:inventory)
scripts/
generate-messages.ts AsyncAPI → core/src/messages.ts via Modelina (with CI drift check)
run-e2e.mjs Playwright wrapper (run-id namespacing, video attach flags)
generate-e2e-inventory.mjs Splices test list into e2e/README.md (CI drift check)
build-allure-report.mjs Combine e2e+server+webview Allure results
assemble-vercel-output.mjs Stage /reports/allure/ for Vercel deploy
asset-manager.html Unified furniture editor (positions + metadata)
jsonl-viewer.html Standalone JSONL transcript inspector
wall-tile-editor.html Wall sprite editor
core/ npm workspace (no separate package; root manages)
server/ npm workspace
webview-ui/ npm workspace
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.
- 7d ago First seen · 650 lines · 15,023 tokens per session scan B a2956ddc65dc
pixel-agents CLAUDE.md is an instructions file published in the GitHub repository pixel-agents-hq/pixel-agents (9,192 stars, last pushed today), licensed MIT. It adds 15,023 tokens to every session, about $0.0751 per session on Opus 5. A static security scan graded it B with 1 finding (reads agent configuration directories). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.
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.
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.
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).
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).
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.
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.