BitSquare/Codeman
2
0
Fork 0
mirror of https://github.com/Ark0N/Codeman.git synced 2026-10-07 07:59:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: add test files, session modes, and prominent dev gotcha

Browse Source 
- Move npm run dev gotcha outside code block for visibility
- Add test/ directory with descriptions for each test file
- Document SessionMode type ('claude' vs 'shell')

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit is contained in:
arkon
2026-01-19 16:45:32 +01:00
co-authored by Claude Opus 4.5
parent 085b78c5e3
commit 1ffefa41aa
1 changed files with 20 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CLAUDE.md
+20 -3
View File
@@ -12,6 +12,8 @@ Claudeman is a Claude Code session manager with a web interface and autonomous R
## Commands ## Commands
**GOTCHA**: `npm run dev` runs CLI help, NOT the web server. Always use `npx tsx src/index.ts web` for development.
```bash ```bash
npm run build # Compile TypeScript + copy static files to dist/web/ npm run build # Compile TypeScript + copy static files to dist/web/
npm run clean # Remove dist/ npm run clean # Remove dist/
@@ -22,9 +24,6 @@ npx tsx src/index.ts web -p 8080 # Dev mode with custom port
node dist/index.js web # After npm run build node dist/index.js web # After npm run build
claudeman web # After npm link claudeman web # After npm link
# ⚠️ GOTCHA: `npm run dev` runs CLI help, NOT the web server!
# Always use `npx tsx src/index.ts web` for development
# Testing (vitest - tests run against WebServer, no real Claude CLI spawned) # Testing (vitest - tests run against WebServer, no real Claude CLI spawned)
npm run test # Run all tests once npm run test # Run all tests once
npm run test:watch # Watch mode npm run test:watch # Watch mode
@@ -67,6 +66,18 @@ src/
│ └── index.html # Single page with modal templates │ └── index.html # Single page with modal templates
└── templates/ └── templates/
└── claude-md.ts # CLAUDE.md generator for new cases └── claude-md.ts # CLAUDE.md generator for new cases
test/
├── session.test.ts # Core session creation, lifecycle, PTY behavior
├── pty-interactive.test.ts # Interactive mode, terminal input/output
├── respawn-controller.test.ts # Respawn state machine, idle detection
├── inner-loop-tracker.test.ts # Ralph loop and todo detection parsing
├── quick-start.test.ts # Quick-start API endpoint
├── scheduled-runs.test.ts # Timed/scheduled session runs
├── sse-events.test.ts # Server-Sent Events broadcasting
├── integration-flows.test.ts # Multi-step workflow tests
├── session-cleanup.test.ts # Resource cleanup, buffer trimming
└── edge-cases.test.ts # Error handling, boundary conditions
``` ```
### Data Flow ### Data Flow
@@ -86,6 +97,12 @@ src/
| WebServer | `web/server.ts` | Fastify REST + SSE at `/api/events` | | WebServer | `web/server.ts` | Fastify REST + SSE at `/api/events` |
| InnerLoopTracker | `inner-loop-tracker.ts` | Detects `<promise>PHRASE</promise>`, todos, loop status in output | | InnerLoopTracker | `inner-loop-tracker.ts` | Detects `<promise>PHRASE</promise>`, todos, loop status in output |
### 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
## Code Patterns ## Code Patterns
### Pre-compiled Regex Patterns ### Pre-compiled Regex Patterns