2026-01-18 04:50:46 +01:00
# CLAUDE.md
2026-01-18 07:31:19 +01:00
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
2026-01-18 04:50:46 +01:00
2026-01-21 04:44:19 +01:00
## ⚠️ CRITICAL: Screen Session Safety
**You may be running inside a Claudeman-managed screen session.** Before killing ANY screen or Claude process:
1. **Check environment** : `echo $CLAUDEMAN_SCREEN` - if it returns `1` , you're in a managed session
2. **NEVER run** `screen -X quit` , `pkill screen` , or `pkill claude` without first confirming you're not killing yourself
3. **Safe debugging** : Use `screen -ls` to LIST sessions, but don't kill them blindly
4. **If you need to kill screens** : Use the web UI or `./scripts/screen-manager.sh` instead of direct commands
**Why this matters** : Killing your own screen terminates your session mid-work, losing context and potentially corrupting state.
2026-01-18 04:50:46 +01:00
## Project Overview
2026-01-18 05:17:06 +01:00
2026-01-18 07:31:19 +01:00
Claudeman is a Claude Code session manager with a web interface and autonomous Ralph Loop. It spawns Claude CLI processes via PTY, streams output in real-time via SSE, and supports scheduled/timed runs.
2026-01-18 04:50:46 +01:00
2026-01-25 17:56:31 +01:00
**Version** : 0.1356
2026-01-25 04:07:43 +01:00
2026-01-19 11:19:13 +01:00
**Tech Stack** : TypeScript (ES2022/NodeNext, strict mode), Node.js, Fastify, Server-Sent Events, node-pty
2026-01-18 05:17:06 +01:00
2026-01-24 02:46:24 +01:00
**Key Dependencies** : fastify (REST API), node-pty (PTY spawning), ink/react (TUI), xterm.js (web terminal), @modelcontextprotocol/sdk (MCP server for spawn protocol)
2026-01-21 23:55:16 +01:00
2026-01-24 17:53:16 +01:00
**Requirements** : Node.js 18+, Claude CLI (`claude` ) installed, GNU Screen (`apt install screen` / `brew install screen` )
> **Note**: `claude` does not need to be in the server process's PATH. Claudeman auto-discovers the binary from common install locations (`~/.local/bin`, `~/.claude/local`, `/usr/local/bin`, etc.) and augments PATH for spawned sessions.
2026-01-19 02:06:37 +01:00
2026-01-24 19:12:47 +01:00
> **Runtime**: The web server runs as a systemd user service (`claudeman-web.service`) on HTTPS port 3000 with a self-signed certificate. It auto-restarts and survives logout.
2026-01-20 08:56:15 +01:00
## First-Time Setup
```bash
npm install
```
2026-01-18 07:31:19 +01:00
## Commands
2026-01-18 05:17:06 +01:00
2026-01-19 19:56:37 +01:00
**CRITICAL** : `npm run dev` runs CLI help, NOT the web server. Use `npx tsx src/index.ts web` for development.
2026-01-19 16:45:32 +01:00
2026-01-25 05:54:54 +01:00
**COM Shorthand** : When user says "COM": 1) Increment version in BOTH `package.json` AND `CLAUDE.md` , 2) `git add && git commit && git push && npm run build && systemctl --user restart claudeman-web` . Always bump version on every COM.
2026-01-25 05:53:21 +01:00
2026-01-25 04:57:09 +01:00
### Build & Clean
2026-01-18 05:17:06 +01:00
```bash
2026-01-24 02:46:24 +01:00
npm run build # Compile TS + copy static files + templates + make bins executable
2026-01-18 07:38:19 +01:00
npm run clean # Remove dist/
2026-01-25 04:57:09 +01:00
npm run typecheck # Type check without building (or: npx tsc --noEmit)
```
2026-01-18 05:17:06 +01:00
2026-01-25 04:57:09 +01:00
### Web Server
```bash
2026-01-19 03:43:59 +01:00
npx tsx src/index.ts web # Dev mode - no build needed (RECOMMENDED)
npx tsx src/index.ts web -p 8080 # Dev mode with custom port
2026-01-24 02:46:24 +01:00
npx tsx src/index.ts web --https # Dev mode with self-signed TLS (enables browser notifications)
2026-01-20 19:43:29 +01:00
npm run web # After npm run build (shorthand)
2026-01-19 03:43:59 +01:00
node dist/index.js web # After npm run build
claudeman web # After npm link
2026-01-25 04:57:09 +01:00
```
2026-01-19 03:43:59 +01:00
2026-01-25 04:57:09 +01:00
### TUI (Terminal User Interface)
```bash
2026-01-21 09:54:42 +01:00
npx tsx src/index.ts tui # Dev mode - prompts to start web if not running
2026-01-21 06:21:25 +01:00
claudeman tui # After npm link
2026-01-21 09:54:42 +01:00
claudeman tui --with-web # Auto-start web server if not running (no prompt)
claudeman tui --no-web # Skip web server check entirely
claudeman tui -p 8080 # Specify web server port
2026-01-25 04:57:09 +01:00
```
2026-01-21 06:21:25 +01:00
2026-01-25 04:57:09 +01:00
### Testing
```bash
2026-01-19 05:28:45 +01:00
npm run test # Run all tests once
npm run test:watch # Watch mode
npm run test:coverage # With coverage report
npx vitest run test/session.test.ts # Single file
npx vitest run -t "should create session" # By pattern
2026-01-25 04:57:09 +01:00
```
2026-01-20 08:56:15 +01:00
2026-01-25 04:57:09 +01:00
**Test Configuration** (vitest.config.ts):
- `globals: true` - no imports needed for `describe` /`it` /`expect`
- `testTimeout: 30000` - 30s for integration tests
- `teardownTimeout: 60000` - 60s ensures cleanup runs even on failures
- `fileParallelism: false` - sequential file execution to respect screen session limits
- Coverage excludes entry points: `src/index.ts` , `src/cli.ts`
2026-01-20 08:56:15 +01:00
2026-01-25 04:57:09 +01:00
**Test Port Allocation** (integration tests spawn servers):
2026-01-19 13:41:27 +01:00
2026-01-25 04:57:09 +01:00
| Port | Test File |
|------|-----------|
| 3099 | quick-start.test.ts |
| 3102 | session.test.ts |
| 3105 | scheduled-runs.test.ts |
| 3107 | sse-events.test.ts |
| 3110 | edge-cases.test.ts |
| 3115 | integration-flows.test.ts |
| 3120 | session-cleanup.test.ts |
| 3125 | ralph-integration.test.ts |
2026-01-25 07:57:12 +01:00
| 3127 | respawn-integration.test.ts (reserved) |
| 3128+ | Next available |
2026-01-19 11:19:13 +01:00
2026-01-25 07:57:12 +01:00
Unit tests (no port needed): respawn-controller, ralph-tracker, pty-interactive, task-queue, task, ralph-loop, session-manager, state-store, types, templates, ralph-config, spawn-detector, spawn-types, spawn-orchestrator, hooks-config, ai-idle-checker, ai-plan-checker
**Test Utilities** : `test/respawn-test-utils.ts` provides MockSession, MockAiIdleChecker, MockAiPlanChecker, time controller, state tracker, and event recorder for respawn controller testing. See `test/respawn-test-plan.md` for architecture and `test/respawn-scenarios.md` for comprehensive test scenarios.
2026-01-25 04:57:09 +01:00
**Test Safety** : `test/setup.ts` enforces max 10 concurrent screens, performs orphan cleanup, and protects its own process tree. You can safely run tests from within a Claudeman-managed session - the cleanup will not kill your own Claude instance. The respawn-controller tests use MockSession (not real screens).
2026-01-25 09:08:57 +01:00
**Test Cleanup Patterns** : Integration tests track resources in `createdSessions` and `createdCases` arrays, cleaned up by `afterAll` /`afterEach` hooks. However, some tests perform cleanup in the test body itself (e.g., `edge-cases.test.ts:273-302` creates 5 sessions and cleans them in a loop). If assertions fail before cleanup code runs, resources leak.
**Known Cleanup Issues** :
- `pty-interactive.test.ts` : Uses `await session.stop()` at end of each test, not in `afterEach` . Test failures leave sessions running.
- `edge-cases.test.ts` : Multiple sessions created in test body with cleanup at end; failures leak sessions.
- Test cases (`~/claudeman-cases/` ): Cases named `flow-test-*` , `ralph-track-loop-*` , `session-detail-*` may persist after test failures.
**Manual Cleanup** :
```bash
# Remove orphaned test cases
rm -rf ~/claudeman-cases/flow-test-* ~/claudeman-cases/ralph-track-loop-* ~/claudeman-cases/session-detail-*
# Kill orphaned test screens (only detached claudeman screens)
screen -ls | grep -E 'Detached.*claudeman' | cut -d. -f1 | xargs -I{} screen -S {} -X quit
```
2026-01-25 04:57:09 +01:00
### MCP Server
```bash
2026-01-24 02:46:24 +01:00
npx tsx src/mcp-server.ts # Dev mode (stdio transport)
2026-01-25 04:57:09 +01:00
```
2026-01-24 02:46:24 +01:00
2026-01-25 04:57:09 +01:00
Configure in Claude Code's MCP settings:
```json
{ "command" : "node" , "args" : [ "dist/mcp-server.js" ], "env" : { "CLAUDEMAN_API_URL" : "http://localhost:3000" , "CLAUDEMAN_SESSION_ID" : "<id>" } }
```
### Debugging
```bash
2026-01-19 11:19:13 +01:00
screen -ls # List GNU screen sessions
2026-01-20 17:43:36 +01:00
screen -r <name> # Attach to screen session (Ctrl+A D to detach)
2026-01-19 11:19:13 +01:00
curl localhost:3000/api/sessions # Check active sessions
2026-01-20 17:43:36 +01:00
curl localhost:3000/api/status | jq . # Full app state including respawn
2026-01-20 08:56:15 +01:00
cat ~/.claudeman/state.json | jq . # View main state
2026-01-21 22:36:45 +01:00
cat ~/.claudeman/state-inner.json | jq . # View Ralph loop state
2026-01-25 04:57:09 +01:00
```
2026-01-20 17:43:36 +01:00
2026-01-25 04:57:09 +01:00
### Systemd Service
```bash
2026-01-24 04:06:35 +01:00
systemctl --user status claudeman-web # Check status
systemctl --user restart claudeman-web # Restart
systemctl --user stop claudeman-web # Stop
journalctl --user -u claudeman-web -f # Stream logs
2026-01-25 04:57:09 +01:00
```
2026-01-24 04:06:35 +01:00
2026-01-25 04:57:09 +01:00
Install: `ln -sf scripts/claudeman-web.service ~/.config/systemd/user/`
Enable: `systemctl --user enable claudeman-web && loginctl enable-linger $USER`
### Kill Stuck Screens
```bash
2026-01-20 17:43:36 +01:00
screen -X -S <name> quit # Graceful quit
pkill -f "SCREEN.*claudeman" # Force kill all claudeman screens
2026-01-18 05:17:06 +01:00
```
2026-01-21 23:55:16 +01:00
## CLI Commands
```bash
claudeman session [ s] # Manage Claude sessions
start # Start new session
stop <id> # Stop session
list [ ls] # List all
logs <id> # View output
claudeman task [ t] # Manage tasks
add <prompt> # Add task
list [ ls] # List tasks
status <id> # Task details
remove [ rm] <id> # Remove task
clear # Clear completed/failed
claudeman ralph [ r] # Control Ralph loop
start # Start loop
stop # Stop loop
status # Show status
claudeman web # Start web interface
claudeman tui # Start TUI
claudeman status # Overall status
claudeman reset # Reset all state
```
2026-01-18 07:31:19 +01:00
## Architecture
2026-01-18 05:17:06 +01:00
2026-01-20 08:56:15 +01:00
### Key Files
2026-01-19 16:45:32 +01:00
2026-01-20 08:56:15 +01:00
| File | Purpose |
|------|---------|
| `src/session.ts` | Core PTY wrapper for Claude CLI. Modes: `runPrompt()` , `startInteractive()` , `startShell()` |
| `src/respawn-controller.ts` | State machine for autonomous session cycling |
2026-01-24 19:12:47 +01:00
| `src/ai-idle-checker.ts` | Spawns fresh Claude session to analyze terminal output for IDLE/WORKING verdict |
2026-01-25 07:57:12 +01:00
| `src/ai-plan-checker.ts` | Spawns fresh Claude session to detect plan mode approval prompts for auto-accept |
2026-01-20 08:56:15 +01:00
| `src/screen-manager.ts` | GNU screen persistence, ghost discovery, 4-strategy kill |
2026-01-21 22:36:45 +01:00
| `src/ralph-tracker.ts` | Detects `<promise>PHRASE</promise>` , todos, loop status in output |
| `src/ralph-config.ts` | Parses `.claude/ralph-loop.local.md` and CLAUDE.md for Ralph config |
2026-01-20 08:56:15 +01:00
| `src/task-tracker.ts` | Parses background task output (agent IDs, status) from Claude CLI |
2026-01-20 17:43:36 +01:00
| `src/session-manager.ts` | Manages session lifecycle, task assignment, and cleanup |
| `src/state-store.ts` | JSON persistence to `~/.claudeman/` with debounced writes |
2026-01-20 08:56:15 +01:00
| `src/web/server.ts` | Fastify REST API + SSE at `/api/events` |
| `src/web/public/app.js` | Frontend: SSE handling, xterm.js, tab management |
2026-01-21 06:21:25 +01:00
| `src/tui/App.tsx` | TUI main component: tabs, terminal viewport, status bar (Ink/React) |
2026-01-21 08:35:49 +01:00
| `src/tui/components/*.tsx` | TUI components: StartScreen, TabBar, TerminalView, StatusBar, RalphPanel, HelpOverlay |
2026-01-21 06:21:25 +01:00
| `src/tui/hooks/useSessionManager.ts` | TUI session state, screen polling, input handling |
2026-01-24 02:46:24 +01:00
| `src/hooks-config.ts` | Generates .claude/settings.local.json with Claude Code hooks for desktop notifications |
2026-01-20 08:56:15 +01:00
| `src/types.ts` | All TypeScript interfaces |
2026-01-21 19:49:44 +01:00
| `src/templates/claude-md.ts` | CLAUDE.md template generation with placeholder support |
2026-01-22 22:43:09 +01:00
| `src/templates/case-template.md` | Default CLAUDE.md template for new cases (with placeholders) |
2026-01-23 10:20:37 +01:00
| `src/spawn-types.ts` | Types, YAML parser, factory functions for spawn1337 protocol |
2026-01-24 02:46:24 +01:00
| `src/spawn-detector.ts` | Detects `<spawn1337>` tags in terminal output (legacy, replaced by MCP) |
2026-01-23 10:20:37 +01:00
| `src/spawn-orchestrator.ts` | Full agent lifecycle: spawn, monitor, budget, queue, cleanup |
| `src/spawn-claude-md.ts` | Generates CLAUDE.md for spawned agent sessions |
2026-01-24 02:46:24 +01:00
| `src/mcp-server.ts` | MCP server binary (`claudeman-mcp` ) exposing spawn tools to Claude Code |
2026-01-25 17:40:28 +01:00
| `src/subagent-watcher.ts` | Monitors Claude Code background agents in `~/.claude/projects/*/subagents/*.jsonl` |
2026-01-24 02:46:24 +01:00
| `src/tui/DirectAttach.ts` | Full-screen console attach with tab switching between sessions |
2026-01-24 04:06:35 +01:00
| `scripts/claudeman-web.service` | Systemd user service for `claudeman web --https` (Restart=always) |
2026-01-19 19:56:37 +01:00
2026-01-18 07:38:19 +01:00
### Data Flow
2026-01-24 17:53:16 +01:00
1. **Session** spawns `claude -p --dangerously-skip-permissions` via `node-pty` (PATH augmented to include claude's install directory)
2026-01-18 07:38:19 +01:00
2. PTY output is buffered, ANSI stripped, and parsed for JSON messages
3. **WebServer** broadcasts events to SSE clients at `/api/events`
2026-01-22 20:49:09 +01:00
4. Full session state (settings, tokens, respawn config, Ralph state) persists to `~/.claudeman/state.json` via **StateStore**
5. Screen metadata persists separately to `~/.claudeman/screens.json` for session recovery
2026-01-18 07:31:19 +01:00
2026-01-19 18:34:43 +01:00
### Respawn State Machine
2026-01-25 07:57:12 +01:00
State machine for autonomous session cycling: `watching` → `confirming_idle` → `ai_checking` → `sending_update` → `waiting_update` → `sending_clear` → `waiting_clear` → `sending_init` → `waiting_init` → `monitoring_init` → (optionally) `sending_kickstart` . Steps can be skipped via config (`sendClear: false` , `sendInit: false` ). After each step, waits for `completionConfirmMs` (10s) of output silence before proceeding. AI idle check uses a fresh Claude session to analyze terminal output for IDLE/WORKING verdict.
2026-01-19 18:34:43 +01:00
2026-01-24 19:47:07 +01:00
See `docs/respawn-state-machine.md` for the full state diagram, idle detection layers, and auto-accept behavior.
2026-01-22 21:36:43 +01:00
2026-01-23 10:20:37 +01:00
### Spawn1337 Protocol (Autonomous Agents)
2026-01-24 19:47:07 +01:00
Spawned agents are full-power Claude sessions in their own screen sessions, managed via MCP tools (`spawn_agent` , `list_agents` , `get_agent_status` , `get_agent_result` , `send_agent_message` , `cancel_agent` ). Max 5 concurrent, max depth 3, default timeout 30min. Agents communicate via filesystem (`spawn-comms/` ) and signal completion via `<promise>PHRASE</promise>` .
2026-01-23 10:20:37 +01:00
2026-01-24 19:47:07 +01:00
See `docs/spawn-protocol.md` for the full protocol flow, directory structure, resource governance, and MCP configuration.
2026-01-23 10:20:37 +01:00
2026-01-25 17:40:28 +01:00
### Subagent Watcher (Claude Code Background Agents)
Monitors Claude Code's internal background agents (the `Task` tool) in real-time. Watches `~/.claude/projects/{project}/{session}/subagents/agent-{id}.jsonl` files and emits structured events.
**Events** : `subagent:discovered` , `subagent:tool_call` , `subagent:progress` , `subagent:message` , `subagent:completed`
**API** :
- `GET /api/subagents` - List all known subagents (optional `?minutes=60` for recent only)
- `GET /api/subagents/:agentId` - Get subagent info
- `GET /api/subagents/:agentId/transcript` - Get transcript (`?limit=N` , `?format=formatted` )
- `DELETE /api/subagents/:agentId` - Kill subagent process
- `GET /api/sessions/:id/subagents` - Get subagents for session's working directory
**Status lifecycle** : `active` → `idle` (30s no activity) → `completed` (process exited or file stale)
Implementation: `src/subagent-watcher.ts` - singleton `subagentWatcher` started on server boot.
2026-01-19 16:45:32 +01:00
### Session Modes
Sessions have a `mode` property (`SessionMode` type):
- **`'claude'` **: Runs Claude CLI for AI interactions (default)
- **`'shell'` **: Runs a plain bash shell for debugging/testing
2026-01-21 04:44:19 +01:00
### Screen-Aware Sessions
All Claude sessions spawned by Claudeman receive environment variables indicating they're running in a managed screen:
| Variable | Value | Purpose |
|----------|-------|---------|
| `CLAUDEMAN_SCREEN` | `1` | Indicates session is managed by Claudeman |
| `CLAUDEMAN_SESSION_ID` | `<uuid>` | Unique session identifier |
| `CLAUDEMAN_SCREEN_NAME` | `claudeman-<name>` | GNU screen session name |
This prevents Claude from accidentally killing its own screen session. The default CLAUDE.md template includes guidance about this.
2026-01-24 17:53:16 +01:00
**Implementation** : Set in `screen-manager.ts:createScreen()` for screen-based sessions and `session.ts:startInteractive()` /`startShell()` for PTY-only sessions. Both paths also augment `PATH` with the claude binary's directory to ensure discovery in restricted environments (systemd, non-login shells).
2026-01-21 04:44:19 +01:00
2026-01-18 05:17:06 +01:00
## Code Patterns
2026-01-19 12:52:29 +01:00
### Pre-compiled Regex Patterns
For performance, regex patterns that are used frequently should be compiled once at module level:
```typescript
// Good - compile once
const ANSI_ESCAPE_PATTERN = /\x1b\[[0-9;]*m/g ;
const TOKEN_PATTERN = /(\d+(?:\.\d+)?)\s*([kKmM])?\s*tokens/ ;
// Bad - recompiles on each call
function parse ( line : string ) {
return line . replace ( /\x1b\[[0-9;]*m/g , '' );
}
```
2026-01-18 07:31:19 +01:00
### Claude Message Parsing
Claude CLI outputs newline-delimited JSON. Strip ANSI codes before parsing:
2026-01-18 05:17:06 +01:00
```typescript
2026-01-19 12:52:29 +01:00
const cleanLine = line . replace ( ANSI_ESCAPE_PATTERN , '' );
2026-01-18 07:31:19 +01:00
const msg = JSON . parse ( cleanLine ) as ClaudeMessage ;
2026-01-18 21:37:03 +01:00
// msg.type: 'system' | 'assistant' | 'user' | 'result'
2026-01-18 07:31:19 +01:00
// msg.message?.content: Array<{ type: 'text', text: string }>
// msg.total_cost_usd: number (on result messages)
2026-01-18 05:17:06 +01:00
```
2026-01-18 21:37:03 +01:00
### PTY Spawn Modes
2026-01-24 17:53:16 +01:00
All PTY spawns pass `PATH: getAugmentedPath()` in the env to ensure `claude` is discoverable even when the server runs in a restricted environment (e.g., systemd). The `getAugmentedPath()` function (in `session.ts` ) resolves the claude binary's directory once at startup and prepends it to PATH. The `screen-manager.ts` equivalent (`findClaudeDir()` ) does the same for screen-based spawns via `export PATH="<dir>:$PATH"` in the bash command.
2026-01-18 21:37:03 +01:00
```typescript
2026-01-19 10:36:30 +01:00
// One-shot mode (JSON output for token tracking)
2026-01-24 17:53:16 +01:00
pty . spawn ( 'claude' , [ '-p' , '--dangerously-skip-permissions' , '--output-format' , 'stream-json' , prompt ], {
env : { ... process . env , PATH : getAugmentedPath (), ... }
})
2026-01-18 21:37:03 +01:00
2026-01-19 10:36:30 +01:00
// Interactive mode (tokens parsed from status line)
2026-01-24 17:53:16 +01:00
pty . spawn ( 'claude' , [ '--dangerously-skip-permissions' ], {
env : { ... process . env , PATH : getAugmentedPath (), ... }
})
2026-01-19 18:04:50 +01:00
// Shell mode (debugging/testing - no Claude CLI)
pty . spawn ( 'bash' , [], { ... })
2026-01-18 21:37:03 +01:00
```
2026-01-24 17:53:16 +01:00
**PATH resolution search order** (both `session.ts` and `screen-manager.ts` ):
1. `which claude` (respects current PATH)
2. `~/.local/bin/claude`
3. `~/.claude/local/claude`
4. `/usr/local/bin/claude`
5. `~/.npm-global/bin/claude`
6. `~/bin/claude`
2026-01-20 08:40:14 +01:00
### Sending Input to Sessions
2026-01-19 16:35:20 +01:00
2026-01-24 19:12:47 +01:00
Two methods:
1. ** `session.write(data)` ** - Direct PTY write (used by `/api/sessions/:id/input` endpoint)
2. ** `session.writeViaScreen(data)` ** - Via GNU screen (RECOMMENDED for programmatic input). Used by RespawnController, auto-compact, auto-clear.
2026-01-20 08:40:14 +01:00
**How `writeViaScreen` works internally** (in `screen-manager.ts:sendInput` ):
1. Splits input into text and `\r` (carriage return)
2. Sends text first: `screen -S name -p 0 -X stuff "text"`
3. Sends Enter separately: `screen -S name -p 0 -X stuff "$(printf '\015')"`
2026-01-24 19:12:47 +01:00
**Why separate commands?** Claude CLI uses Ink (React for terminals) which requires text and Enter as separate `screen -X stuff` commands. Combining them doesn't work. This is a critical implementation detail when debugging input issues.
2026-01-19 16:35:20 +01:00
2026-01-18 07:31:19 +01:00
### Idle Detection
2026-01-19 15:00:49 +01:00
**Session** : emits `idle` /`working` events on prompt detection + 2s activity timeout.
2026-01-18 07:31:19 +01:00
2026-01-24 19:47:07 +01:00
**RespawnController** : Multi-layer detection (completion message → AI idle check → output silence → token stability → working pattern absence). See `docs/respawn-state-machine.md` for full details.
2026-01-23 01:25:45 +01:00
2026-01-19 10:36:30 +01:00
### Token Tracking
2026-01-18 21:37:03 +01:00
2026-01-19 10:36:30 +01:00
- **One-shot mode**: Uses `--output-format stream-json` for detailed token usage from JSON
- **Interactive mode**: Parses tokens from Claude's status line (e.g., "123.4k tokens"), estimates 60/40 input/output split
2026-01-18 21:37:03 +01:00
2026-01-19 13:08:53 +01:00
### Auto-Compact & Auto-Clear
2026-01-19 15:00:49 +01:00
| Feature | Default Threshold | Action |
|---------|------------------|--------|
| Auto-Compact | 110k tokens | `/compact` with optional prompt |
| Auto-Clear | 140k tokens | `/clear` to reset context |
2026-01-19 13:08:53 +01:00
2026-01-19 15:00:49 +01:00
Both wait for idle. Configure via `session.setAutoCompact()` / `session.setAutoClear()` .
2026-01-19 13:08:53 +01:00
2026-01-21 22:36:45 +01:00
### Ralph / Todo Tracking
2026-01-19 13:24:45 +01:00
2026-01-24 19:47:07 +01:00
Detects Ralph loops and todos inside Claude sessions. **Disabled by default** but auto-enables when Ralph-related patterns are detected (promise tags, TodoWrite, iteration patterns, etc.). See `ralph-tracker.ts:shouldAutoEnable()` for the full pattern list.
2026-01-21 22:36:45 +01:00
2026-01-24 19:12:47 +01:00
**Auto-Configuration from Ralph Plugin State** : When a session starts, Claudeman reads `.claude/ralph-loop.local.md` to auto-configure:
2026-01-21 22:36:45 +01:00
```yaml
---
enabled : true
iteration : 5
max-iterations : 50
completion-promise : "COMPLETE"
---
```
2026-01-24 19:12:47 +01:00
Priority: 1) `.claude/ralph-loop.local.md` (official Ralph plugin state), 2) `CLAUDE.md` `<promise>` tags (fallback). See `src/ralph-config.ts` .
2026-01-21 22:36:45 +01:00
2026-01-24 19:12:47 +01:00
**Completion Detection** (multi-strategy):
2026-01-20 17:43:36 +01:00
- 1st occurrence of `<promise>PHRASE</promise>` : Stores as expected phrase (likely in prompt)
- 2nd occurrence: Emits `completionDetected` event (actual completion)
- **Bare phrase detection**: Also detects phrase without tags once expected phrase is known
- **All complete detection**: When "All X files/tasks created/completed" detected, marks all todos complete and emits completion
- If loop is already active (via `/ralph-loop:ralph-loop` ): Emits immediately on first occurrence
**Session Lifecycle** : Each session has its own independent tracker:
- New session → Fresh tracker (no carryover)
- Close tab → Tracker state cleared, UI panel hides
- `tracker.reset()` → Clears todos/state, keeps enabled status
- `tracker.fullReset()` → Complete reset to initial state
2026-01-24 19:12:47 +01:00
- `tracker.configure({ enabled?, completionPhrase?, maxIterations? })` → Partial config update
2026-01-20 17:43:36 +01:00
**API** :
2026-01-21 22:36:45 +01:00
- `GET /api/sessions/:id/ralph-state` - Get loop state and todos
- `POST /api/sessions/:id/ralph-config` - Configure tracker:
2026-01-20 17:43:36 +01:00
- `{ enabled: boolean }` - Enable/disable
- `{ reset: true }` - Soft reset (keep enabled)
- `{ reset: "full" }` - Full reset
2026-01-19 15:00:49 +01:00
### Terminal Display Fix
2026-01-19 13:24:45 +01:00
2026-01-19 15:00:49 +01:00
Tab switch/new session fix: clear xterm → write buffer → resize PTY → Ctrl+L redraw. Uses `pendingCtrlL` Set, triggered on `session:idle` /`session:working` events.
2026-01-19 11:19:13 +01:00
2026-01-19 05:28:45 +01:00
### SSE Events
2026-01-18 07:31:19 +01:00
2026-01-19 05:28:45 +01:00
All events broadcast to `/api/events` with format: `{ type: string, sessionId?: string, data: any }` .
2026-01-18 07:31:19 +01:00
2026-01-25 17:40:28 +01:00
Event prefixes: `session:` , `task:` , `respawn:` , `spawn:` , `subagent:` , `hook:` , `scheduled:` , `case:` , `screen:` , `init` .
2026-01-20 08:56:15 +01:00
2026-01-24 19:12:47 +01:00
Key events (see `app.js:handleSSEEvent()` ):
- `session:idle` , `session:working` - Status indicators
2026-01-20 08:56:15 +01:00
- `session:terminal` , `session:clearTerminal` - Terminal content
2026-01-21 22:36:45 +01:00
- `session:ralphLoopUpdate` , `session:ralphTodoUpdate` , `session:ralphCompletionDetected` - Ralph tracking
2026-01-24 19:12:47 +01:00
- `respawn:detectionUpdate` - Idle detection status
- `spawn:queued` , `spawn:started` , `spawn:completed` , `spawn:failed` - Agent lifecycle
2026-01-25 17:40:28 +01:00
- `subagent:discovered` , `subagent:tool_call` , `subagent:progress` , `subagent:message` , `subagent:completed` - Claude Code background agents
2026-01-24 19:12:47 +01:00
- `hook:idle_prompt` , `hook:permission_prompt` , `hook:elicitation_dialog` , `hook:stop` - Claude Code hooks
2026-01-19 11:19:13 +01:00
### Frontend (app.js)
2026-01-24 19:12:47 +01:00
Vanilla JS + xterm.js. 60fps rendering: server batches terminal data every 16ms, client uses `requestAnimationFrame` to batch xterm.js writes.
2026-01-19 05:28:45 +01:00
2026-01-24 02:46:24 +01:00
### HTTPS & Browser Notifications
2026-01-24 19:12:47 +01:00
**HTTPS** : The `--https` flag generates/reuses self-signed certificates in `~/.claudeman/certs/` . Required for the Web Notification API.
2026-01-24 02:46:24 +01:00
2026-01-24 19:12:47 +01:00
**Notifications** (`NotificationManager` in `app.js` ): In-app drawer, tab title flashing, Web Notification API (rate limited 3s), audio alerts (critical only), tab blinking (red=action, yellow=idle).
2026-01-24 02:46:24 +01:00
2026-01-24 19:12:47 +01:00
**Hook Event Data** : `/api/hook-event` forwards `data` field into SSE broadcast. Hook events: `permission_prompt` , `elicitation_dialog` , `idle_prompt` , `stop` .
2026-01-24 02:46:24 +01:00
2026-01-19 15:00:49 +01:00
### State Store
2026-01-19 12:55:08 +01:00
2026-01-24 19:12:47 +01:00
Writes debounced (500ms) to `~/.claudeman/state.json` via `persistSessionState()` on every meaningful change.
2026-01-22 20:49:09 +01:00
**Per-session fields stored** (`SessionState` in `types.ts` ):
2026-01-24 19:12:47 +01:00
- `id` , `pid` , `status` , `name` , `mode` - Core identity
- `workingDir` , `createdAt` , `lastActivityAt` - Location and timestamps
- `autoClearEnabled/Threshold` , `autoCompactEnabled/Threshold/Prompt` - Context management
- `ralphEnabled` , `ralphCompletionPhrase` - Ralph tracker state
- `respawnEnabled` , `respawnConfig` - Respawn controller state
- `totalCost` , `inputTokens` , `outputTokens` - Token tracking
- `parentAgentId` , `childAgentIds` - Spawn agent tree
2026-01-22 20:49:09 +01:00
2026-01-24 19:12:47 +01:00
CLI commands (`claudeman status/session list` ) read from `state.json` to display web-managed sessions.
2026-01-19 12:55:08 +01:00
2026-01-20 08:56:15 +01:00
### TypeScript Config
2026-01-25 04:57:09 +01:00
Module resolution: NodeNext. Target: ES2022. Strict mode enabled with all additional strictness flags (`noUnusedLocals` , `noUnusedParameters` , `noImplicitReturns` , `noFallthroughCasesInSwitch` , etc.). No ESLint/Prettier configured - rely on TypeScript strict mode.
2026-01-21 19:49:44 +01:00
2026-01-25 04:57:09 +01:00
TUI uses React JSX (`jsx: react-jsx` , `jsxImportSource: react` ) for Ink components.
2026-01-20 08:56:15 +01:00
2026-01-19 07:33:33 +01:00
## Adding New Features
2026-01-20 08:56:15 +01:00
- **API endpoint**: Add types in `types.ts` , route in `server.ts:buildServer()` , use `createErrorResponse()` for errors
- **SSE event**: Emit via `broadcast()` in server.ts, handle in `app.js:handleSSEEvent()` switch
- **Session event**: Add to `SessionEvents` interface in `session.ts` , emit via `this.emit()` , subscribe in server.ts, handle in frontend
2026-01-22 20:49:09 +01:00
- **Session setting**: Add field to `SessionState` in `types.ts` , include in `session.toState()` , call `this.persistSessionState(session)` in server.ts after the change
2026-01-24 02:46:24 +01:00
- **MCP tool**: Add tool definition in `mcp-server.ts` using `server.tool()` , use `apiRequest()` to call Claudeman REST API
2026-01-21 23:55:16 +01:00
- **New test file**: Create `test/<name>.test.ts` , pick unique port (next available: 3127+), add to port allocation comment above
2026-01-20 17:43:36 +01:00
### API Error Codes
Use `createErrorResponse(code, details?)` from `types.ts` :
| Code | Use Case |
|------|----------|
| `NOT_FOUND` | Session/resource doesn't exist |
| `INVALID_INPUT` | Bad request parameters |
| `SESSION_BUSY` | Session is currently processing |
| `OPERATION_FAILED` | Action couldn't complete |
| `ALREADY_EXISTS` | Duplicate resource |
| `INTERNAL_ERROR` | Unexpected server error |
2026-01-19 07:33:33 +01:00
2026-01-19 11:31:32 +01:00
## Session Lifecycle & Cleanup
2026-01-21 04:44:19 +01:00
- **Limit**: Web server: `MAX_CONCURRENT_SESSIONS = 50` (`server.ts:56` ), UI tab limit: 20, CLI default: 5 (`types.ts:DEFAULT_CONFIG` )
2026-01-19 15:00:49 +01:00
- **Kill** (`killScreen()` ): child PIDs → process group → screen quit → SIGKILL
- **Ghost discovery**: `reconcileScreens()` finds orphaned screens on startup
2026-01-22 20:49:09 +01:00
- **Cleanup** (`cleanupSession()` ): stops respawn, clears buffers/timers, kills screen, removes from `state.json`
- **State sync**: Every session create/delete/update calls `persistSessionState()` which writes full state (including respawn config from controller) to `state.json`
2026-01-22 21:36:43 +01:00
- **Recovery on restart**: Server reads `state.json` first (has all settings), falls back to `screens.json` for any sessions not found. Settings (auto-compact, auto-clear, respawn config, Ralph state) restored to live session objects after screen reattachment.
2026-01-19 11:31:32 +01:00
2026-01-24 19:12:47 +01:00
## TUI (WIP)
2026-01-21 22:36:45 +01:00
2026-01-24 19:12:47 +01:00
Ink/React-based TUI in `src/tui/` . Client to the web server, uses `/api/*` endpoints and attaches to screens via GNU screen. Not fully implemented yet.
2026-01-21 22:36:45 +01:00
2026-01-19 12:52:29 +01:00
## Buffer Limits
| Buffer | Max Size | Trim To |
|--------|----------|---------|
2026-01-21 23:55:16 +01:00
| Terminal | 2MB | 1.5MB |
| Text output | 1MB | 768KB |
2026-01-19 12:52:29 +01:00
| Messages | 1000 | 800 |
| Line buffer | 64KB | (flushed every 100ms) |
| Respawn buffer | 1MB | 512KB |
2026-01-24 19:12:47 +01:00
Tab switch uses `tail=256KB` for fast initial load, then chunked 64KB writes via `requestAnimationFrame` .
2026-01-21 23:55:16 +01:00
2026-01-24 19:12:47 +01:00
## API Routes
2026-01-19 13:41:27 +01:00
2026-01-24 19:12:47 +01:00
All routes defined in `server.ts:buildServer()` . Key endpoint groups:
- `/api/events` - SSE stream | `/api/status` - Full app state
- `/api/sessions` - CRUD + `/input` , `/resize` , `/interactive`
- `/api/sessions/:id/respawn/*` - Start/stop/enable/config respawn controller
- `/api/sessions/:id/ralph-*` - Ralph tracker config and state
- `/api/sessions/:id/auto-compact` , `/auto-clear` - Token threshold settings
- `/api/quick-start` - Create case + start session (`{mode?: 'claude'|'shell'}` )
- `/api/cases` , `/api/screens` - Case and screen management
- `/api/spawn/*` - Agent lifecycle (list, status, result, messages, cancel, trigger)
2026-01-25 17:40:28 +01:00
- `/api/subagents` - List/get/kill Claude Code background agents, get transcripts
- `/api/sessions/:id/subagents` - Get subagents for a specific session's working directory
2026-01-24 19:12:47 +01:00
- `/api/hook-event` - Claude Code hook callbacks (`{event, sessionId, data?}` )
2026-01-19 13:41:27 +01:00
2026-01-21 09:54:42 +01:00
2026-01-20 08:56:15 +01:00
## State Files
| File | Purpose |
|------|---------|
2026-01-22 20:49:09 +01:00
| `~/.claudeman/state.json` | Full session state (all settings, tokens, respawn config, Ralph state), tasks, app config |
2026-01-21 22:36:45 +01:00
| `~/.claudeman/state-inner.json` | Ralph loop/todo state per session (separate to reduce writes) |
2026-01-22 20:49:09 +01:00
| `~/.claudeman/screens.json` | Screen session metadata (for recovery after restart) |
| `~/.claudeman/settings.json` | User preferences (lastUsedCase, custom template path) |
2026-01-24 02:46:24 +01:00
| `~/.claudeman/certs/` | Self-signed TLS certificates for `--https` mode |
2026-01-22 20:49:09 +01:00
2026-01-24 19:12:47 +01:00
**Recovery** : On restart, sessions restored from `state.json` (primary) with `screens.json` as fallback. All settings re-applied to live sessions. Cases created in `~/claudeman-cases/` by default.
2026-01-20 08:56:15 +01:00
2026-01-22 22:43:09 +01:00
### CLAUDE.md Templates
2026-01-21 19:49:44 +01:00
2026-01-22 22:43:09 +01:00
New cases get a CLAUDE.md generated from `src/templates/case-template.md` (bundled with the project). Template resolution order:
1. Custom path from `~/.claudeman/settings.json` (`defaultClaudeMdPath` field)
2. Bundled `case-template.md` (copied to `dist/templates/` during build)
3. Minimal fallback (if bundled template is missing)
Placeholders replaced:
2026-01-21 19:49:44 +01:00
- `[PROJECT_NAME]` → Case name
- `[PROJECT_DESCRIPTION]` → Description
- `[DATE]` → Current date (YYYY-MM-DD)
2026-01-21 04:27:09 +01:00
## Screen Session Manager (CLI Tool)
2026-01-24 19:12:47 +01:00
`./scripts/screen-manager.sh` - Interactive bash tool for managing screen sessions. Commands: `list` , `attach N` , `kill N,M` , `kill-all` , `info N` . Requires `jq` and `screen` .
2026-01-21 04:27:09 +01:00
2026-01-20 08:56:15 +01:00
## Documentation
2026-01-24 19:47:07 +01:00
- `docs/respawn-state-machine.md` - Respawn controller states, idle detection, auto-accept
- `docs/spawn-protocol.md` - Spawn1337 agent protocol, MCP tools, resource governance
2026-01-24 19:12:47 +01:00
- `docs/ralph-wiggum-guide.md` - Ralph Wiggum loop guide (plugin reference, prompt templates)
- `docs/claude-code-hooks-reference.md` - Claude Code hooks documentation
2026-01-20 08:56:15 +01:00
2026-01-24 19:12:47 +01:00
### Ralph Wiggum Loops
2026-01-20 08:56:15 +01:00
**Core Pattern** : `<promise>PHRASE</promise>` - The completion signal that tells the loop to stop.
2026-01-20 17:43:36 +01:00
**Skill Commands** :
2026-01-20 08:56:15 +01:00
```bash
2026-01-20 17:43:36 +01:00
/ralph-loop:ralph-loop # Start Ralph Loop in current session
/ralph-loop:cancel-ralph # Cancel active Ralph Loop
/ralph-loop:help # Show help and usage
2026-01-20 08:56:15 +01:00
```
2026-01-24 19:12:47 +01:00
The `RalphTracker` class (`src/ralph-tracker.ts` ) detects Ralph patterns in Claude output and tracks loop state, todos, and completion phrases. It auto-enables when Ralph-related patterns are detected.