mirror of
https://github.com/Ark0N/Codeman.git
synced 2026-10-10 01:09:43 +02:00
Codeman maintainer
9d38cbf51a
- scripts/build.mjs resolves exceljs/dist/exceljs.min.js and fflate first, before tsc and before rm -rf dist/web/public. A tree whose node_modules predate those devDependencies (pulled but never ran npm install) used to fail in prepare-spreadsheet-assets.mjs with the live dist assets already deleted, so the running server served an index.html whose hashed files were gone. It now exits 1 with "run `npm install` first", nothing touched. test/spreadsheet-assets.test.ts pins the order, that the list covers every require.resolve in the prepare script, and runs a relocated copy of the build to prove the exit and message. - CLAUDE.md: the header visibility rule's stock desktop default now lists Tiles (1180px and wider), which ships ON on desktop. - docs/wiki/Agent-CLIs.md: "Before 1.36.0" becomes "Before 1.40.0" (four places); 1.36.0 never ships. - docs/wiki/Home.md: the "Everything in the manual" index lists Tile Grid and Custom Model Endpoints, matching the sidebar. test/wiki-home-index fails when a sidebar page is missing from that index. - docs/wiki/Tile-Grid.md: the Tiles default is off on tablets too since the touch-primary default landed, not only on phones. - docs/browser-testing-guide.md: the fixed port table and new WebServer(PORT) snippet give way to the port-0 pattern (new WebServer(0, false, true), server.boundPort) that test/test-ports-guard.test.ts enforces; the examples that opened localhost:3000, the live instance, use BASE_URL. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
8.5 KiB
8.5 KiB
Mission control for AI coding agents
Codeman runs your coding agents on your own machine and puts them behind one dashboard you can open from any device. It spawns Claude Code, OpenCode, Codex, Antigravity, Gemini, Pi, Grok, DeepSeek Harness, or OMP inside persistent tmux sessions, streams the real terminal to the browser, and keeps working while you are away from the keyboard: it re-prompts idle agents, resumes when a subscription limit resets, runs jobs on a schedule, and shows every background subagent live.
This wiki is the manual. The README is the overview,
and the deep internals live in
docs/.
curl -fsSL https://getcodeman.com/install | bash
codeman web # then open http://localhost:3000
Start here
New to Codeman
- Installation - requirements, the installer, npm and git clone routes, updating.
- Quick Start - from a running server to a working agent in five minutes.
- Core Concepts - cases, sessions, run modes, and what survives a restart.
- The Dashboard - reading the tab strip, the status dots, and the alerts.
Already running it
- Agent CLIs - the ten run modes, their setup, and which features are Claude-only.
- Mobile Guide - phone and tablet use, QR login, the touch keyboard bar.
- Remote Access - Tailscale, Cloudflare tunnel, LAN plus password, QR login.
- Keeping Agents Running - idle detection, respawn cycling, auto-resume on usage limits.
- Troubleshooting - symptom-first index of things that actually break.
Driving it from code
- Driving Codeman From An Agent - the bundled skill, worker sessions, wait primitives.
- HTTP API - the envelope, auth, the endpoint map, SSE events.
- Hooks And Integrations - events flowing back into Codeman.
Everything in the manual
Getting started
| Page | What it answers |
|---|---|
| Installation | How do I install it, update it, and remove it? |
| Quick Start | How do I get one agent working right now? |
| Core Concepts | What is a case, a session, a run mode? |
Using it
| Page | What it answers |
|---|---|
| The Dashboard | What is the UI telling me? |
| Tile Grid | How do I watch and drive several sessions side by side? |
| Agent CLIs | Which agent should this session run, and how do I set it up? |
| Custom Model Endpoints | How do I point a session at my own OpenAI-compatible endpoint? |
| Working With Files | How do I read, edit, and attach files? |
| Input And Voice | How do I talk to an agent, including by voice? |
| Mobile Guide | How well does this work on a phone? |
| Keyboard Shortcuts | What can I drive from the keyboard? |
| Settings Reference | What does this setting do, and why did it not follow me to my phone? |
Keeping agents running
| Page | What it answers |
|---|---|
| Keeping Agents Running | How does it run unattended overnight? |
| Notifications And Approvals | How do I know an agent needs me, and answer from my phone? |
| Cron Jobs | How do I run an agent on a schedule? |
| Autonomous Loops | What are the Ralph and Orchestrator loops for? |
| Watching Agents Work | How do I see what the subagents are doing? |
Where it runs
| Page | What it answers |
|---|---|
| Docker Cases | How do I sandbox a project in a container? |
| Remote SSH Sessions | How do I run the agent on another machine? |
| Web Tabs | Can my Grafana live in here too? |
| Multi-User Mode | Can several people share one Codeman? |
Access and security
| Page | What it answers |
|---|---|
| Remote Access | How do I reach it from outside this machine, safely? |
| Security | What is exposed, what protects it, what do I have to do? |
Automation and integration
| Page | What it answers |
|---|---|
| Driving Codeman From An Agent | How does an agent spawn and drive workers? |
| HTTP API | What can I call, and what comes back? |
| Hooks And Integrations | How do I wire Codeman into something else? |
Operating it
| Page | What it answers |
|---|---|
| Running As A Service | How do I keep it up across reboots, and update it? |
| Troubleshooting | Why is it doing that? |
| FAQ | The questions that keep coming up. |
| Contributing | How do I send a fix? |
| Versioning | What does the version number promise? |
Requirements at a glance
| Thing | Needed |
|---|---|
| OS | macOS or Linux. Windows works through WSL2. |
| Node.js | 22 or newer. |
| tmux | Required. Sessions live in tmux, which is what makes them survive restarts. |
| An agent CLI | At least one of Claude Code, OpenCode, Codex, Gemini, Antigravity, Pi, Grok Build, DeepSeek Harness, OMP. Plain shell sessions need none. |
| Network | Binds to 127.0.0.1 by default. Reaching it from another device is a deliberate step: see Remote Access. |
Codeman is MIT licensed, self-hosted, and sends no telemetry. Everything runs on your machine.
Getting help
- Questions and setup help: Discussions, especially Q&A.
- Bugs: Issues. Include your OS, install method, browser, and which CLI the session was running.
- Ideas and roadmap: Ideas.
- Security: never a public issue. See SECURITY.md.