16 KiB
CLAUDE.md
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
和用户交流时默认使用中文。
Project Overview
多用户 AI Agent 系统,为每个登录用户提供独立的 Docker 容器环境。支持终端交互、文件操作、对话管理和实时监控。主要用于学习和实验"智能体 + 真实 Dev Workflow",代码大量由 AI 生成。
Core Architecture
Entry Points
- 统一入口:
python main.py- 当前实现默认进入 Web 启动流程(thinking_mode=True) - 推荐 Web 入口:
python -m server.app- 封装并转发到server/app_legacy.py,主链路为 REST 任务轮询,默认端口 8091 - 兼容入口:
python web_server.py- 已标记 deprecated,但仍可启动
Key Components
server/ (Flask 业务主线,chat/task 以 REST 任务轮询为主,Socket.IO 用于兼容与实时辅助通道)
app.py/app_legacy.py- Web 服务入口与遗留实现chat.py/chat_flow*.py- 对话与任务流编排(runner / tool_loop / stream_loop / task_main 等拆分)goal_flow.py- 自主目标循环deep_compression.py- 上下文深度压缩tasks.py/monitor.py/conversation.py/files.py/auth.py/admin.py- 任务、监控、对话、文件、认证、管理接口
core/
MainTerminal(main_terminal.py) - CLI 主终端,处理用户输入和 AI 对话循环;逻辑拆分到core/main_terminal_parts/*(commands / context / tools / tools_execution / tools_policy / tools_read 等)WebTerminal(web_terminal.py) - Web 终端,继承 MainTerminal,支持轮询任务与实时通道兼容能力tool_config.py- 定义所有工具的配置和分类
modules/
user_container_manager.py- 单用户-单容器管理,负责容器生命周期container_file_proxy.py- 容器内文件代理,通过docker exec沙箱化文件操作terminal_manager.py- 管理多个持久化终端会话file_manager.py- 文件 CRUD,包含搜索、替换和 append/modify streaming 功能conversation_manager.py- 对话历史持久化context_manager.py- 上下文构建、token统计、对话管理memory_manager.py- 长期记忆管理todo_manager.py- 待办事项管理sub_agent_manager.py- 子智能体任务调度user_manager.py- 用户认证和工作区管理upload_security.py- 上传文件隔离扫描
utils/
api_client.py- 与 OpenAI-compatible API 交互,支持 thinking mode(首次思考,后续快速)terminal_factory.py- 终端类型工厂
static/
- Vue 3 + TS 前端(
static/src/,分层为app/stores/components/composables/),聊天主链路使用 REST 任务轮询,保留 Socket.IO 兼容能力,包含对话流、终端输出、资源监控面板 - 监控动画核心文件:
static/src/components/chat/monitor/MonitorDirector.ts(动画与场景执行)、static/src/stores/monitor.ts(事件队列与状态机)
cli/
- React 19 + Ink 6 + TypeScript CLI 前端(正在重写中),连接现有本地 Web API(默认
127.0.0.1:8091),不是独立 agent runtime - 关键文件:
cli/src/App.tsx、cli/src/components.tsx、cli/src/eventMapper.ts、cli/src/api.ts
docker/
terminal.Dockerfile- 终端容器镜像构建配置
Development Commands
Build & Run
# 安装 Python 依赖
pip install -r requirements.txt
# 构建终端镜像
docker build -f docker/terminal.Dockerfile -t my-agent-shell:latest .
# 统一入口(默认进入 Web 启动流程)
python main.py
# 推荐 Web 启动
python -m server.app
# 可选参数
python -m server.app --path ./project --port 8091 --debug --thinking-mode
# 兼容启动方式(deprecated)
python web_server.py
Frontend (根目录 Vue)
npm install
# 构建(默认只看最后 5 行,减少 Vite 构建资源列表等无关输出)
npm run build --silent 2>&1 | tail -n 5
# 开发监听(当前脚本是 build watch)
npm run dev
# Lint
npm run lint
CLI (React / Ink)
npm --prefix cli install
# 开发启动
npm run cli # 或 npm --prefix cli run dev
# 构建
npm run cli:build
# 类型检查
npm run cli:typecheck
# 可执行命令名(构建后):agents / agents-cli
Testing
# 主要离线冒烟用例(unittest)
python -m unittest test.test_server_refactor_smoke
# 改动后端接口适配(如 server/chat.py)时补充
python3 -m py_compile server/chat.py
# CLI 最小可复现验证
npm --prefix cli run typecheck
npm --prefix cli run build
仓库未发现
pytest.ini/pyproject.toml/tox.ini,不要默认要求pytest作为唯一入口。test/test_system_message.py依赖外部MOONSHOT_API_KEY与网络,不属于离线稳定用例。
Debugging
# 查看容器状态
docker ps -a | grep agent-term
# 查看调试日志
tail -f logs/debug_stream.log
# 查看容器统计
tail -f logs/container_stats.log
Configuration
主要配置文件:.env(复制 .env.example)
必填变量:
AGENT_API_BASE_URL- OpenAI-compatible API 端点AGENT_API_KEY- API 密钥AGENT_MODEL_ID- 模型 ID (例如 deepseek-chat)WEB_SECRET_KEY- Flask session 密钥
容器配置 (config/terminal.py):
TERMINAL_SANDBOX_MODE- docker/hostTERMINAL_SANDBOX_IMAGE- 容器镜像 (默认 python:3.11-slim)TERMINAL_SANDBOX_NETWORK- 网络模式 (bridge/none/host)TERMINAL_SANDBOX_CPUS- CPU 限制TERMINAL_SANDBOX_MEMORY- 内存限制
资源限制:
PROJECT_MAX_STORAGE_MB- 单用户磁盘配额 (默认 2048MB)MAX_ACTIVE_USER_CONTAINERS- 并发容器数量 (默认 8)
Important Implementation Details
File Operations
文件写入统一使用 write_file/edit_file 工具完成:write_file 负责覆盖或追加内容,edit_file 负责精确字符串替换,不再依赖历史版本的流式标签标记。
Container Architecture
每个用户登录时:
UserContainerManager创建专属容器- 容器挂载
users/<username>/project/到/workspace - 所有文件操作通过
ContainerFileProxy在容器内执行 - 终端会话通过
docker exec运行 - 空闲超时或登出后自动销毁容器
Context Management
ContextManager 负责:
- 动态构建上下文(系统提示 + 工具 + 对话历史 + 聚焦文件 + 记忆)
- Token 统计和限制检查
- 对话历史保存和加载
- 自动保存机制(每次 API 调用后增量保存)
Thinking Mode
支持"思考模式"(需配置 AGENT_THINKING_MODEL_ID):
- 首次调用使用 reasoning 模型(如 deepseek-reasoner)
- 后续调用使用快速模型
- 可通过
THINKING_FAST_INTERVAL控制切换频率 - 失败时自动回退到思考模式
Web Socket Events
主要事件:
send_message- 发送用户消息thinking_start/chunk/end- 思考过程text_start/chunk/end- 文本响应tool_preparing/start/update_action- 工具执行状态conversation_list_update- 对话列表更新terminal_output- 终端输出
Common Patterns
Adding New Tools
- 在
core/main_terminal_parts/tools_execution.py(及相关tools_*.py)实现执行逻辑 - 在
core/tool_config.py/core/main_terminal_parts/tools_definition.py中注册工具定义 - 如需在任务流/流式输出中特殊处理,在
server/chat_flow*.py对应环节添加逻辑
代码修改约定
- 最小改动原则:只改与需求直接相关文件,避免顺手重构。
- 文件编辑方式:优先使用原生文件编辑工具,尽量不要用
bash/python脚本批量改文件。 - 后端改动优先级:先改
modules/、server/内对应模块,最后才动入口。 - 前端改动优先级:按
static/src现有分层改(app/stores/components/composables/)。 - CLI 改动优先级:优先在
cli/src/App.tsx、cli/src/components.tsx、cli/src/eventMapper.ts、cli/src/api.ts内做最小闭环修改。 - 涉及 monitor 动画/事件联动时,至少同步检查
MonitorDirector.ts与stores/monitor.ts。 - 前端不强制本地构建:沙箱环境无法成功执行
npm run build/npm run cli:build,因此改完前端不必每次都跑构建验证。改动后用类型检查(npm run lint/npm --prefix cli run typecheck)或人工 review 自查即可,构建交由用户在本机或 CI 完成。
Working with Containers
使用 ContainerHandle:
# 文件操作
result = container_handle.execute_file_op("read", path="/workspace/file.txt")
# 执行命令
result = container_handle.run_command("ls -la /workspace")
# 终端会话
result = container_handle.start_terminal(session_name="main", working_dir="/workspace")
Managing Conversations
# 创建新对话
terminal.create_new_conversation(thinking_mode=True)
# 加载对话
terminal.load_conversation(conversation_id)
# 搜索对话
terminal.search_conversations(query="bug fix")
# 删除对话
terminal.delete_conversation(conversation_id)
前端设计风格统一规范(强制)
适用范围:所有前端 UI(以
static/srcWeb 为主;cli/src在视觉可类比处同样适用;以及未来新增的任何界面)。 约束级别:写新 UI 或改动 UI 时必须遵守;遇到存量违规应在最小改动允许范围内顺手修正。
-
禁止边缘光晕:不使用任何 glow / 外发光 / 彩色光晕效果(大范围彩色
box-shadow扩散、用filter: drop-shadow做光圈、::before/::after模糊光晕等)。已有的要移除。允许的只是中性、克制的投影——沿用--claude-shadow/--theme-shadow-*这类已有 token,不要自造发光阴影。 -
禁止原生浏览器组件:不直接使用浏览器默认外观的
<select>、<input type=checkbox/radio/range/date/color>、alert/confirm/prompt、原生右键菜单、原生 tooltip 等。一律替换为与项目风格统一的自定义组件(下拉、开关、单选、滑块、模态、Toast 等)。 -
禁止圆角套娃:不允许「圆角矩形里再套圆角矩形再套圆角矩形」的多层嵌套卡片——这是典型的垃圾审美,且会极大占据有效显示面积。容器层级要扁平:能用分隔线 / 留白 / 底色区分的,就不要再多包一层带边框圆角的盒子。
-
图标外框对齐:同一组图标按钮的外框(点击热区 / 容器)必须对齐统一,不能一个居中、一个左对齐、一个右对齐。同组按钮固定相同尺寸与对齐方式。
-
图标视觉对齐而非理论对齐:按图标的视觉重心对齐,而不是几何边界盒。对视觉重心偏移的图标(三角形 / 播放键 / 放大镜等)做微调(micro-nudge),让它「看起来居中」而非「数值上居中」。
-
颜色遵循三模式切换:所有颜色必须走原生三模式(经典
classic/ 明亮light/ 夜间dark)。禁止写死颜色字面量,一律使用 CSS 变量(--claude-*/--theme-*,定义在static/src/styles/base/_tokens.scss,由:root[data-theme='classic'|'light'|'dark']提供;切换逻辑见static/src/utils/theme.ts)。新增颜色必须在三套主题里都补齐。 -
带文字容器固定高度:所有含内部文字的选项 / 按钮 / 标签 / 容器必须固定高度,禁止因文字多少被撑大撑高。文字过长用省略号或内部滚动处理,保持行高与块高稳定。
-
窗口设最大尺寸 + 内部滚动:所有弹窗 / 面板 / 列表必须设置
max-height/max-width,超出时由内部容器滚动,而不是把整个窗口顶大。滚动条要么隐藏,要么做样式适配(贴合整体设计,不暴露原生粗滚动条)。
Security Considerations
- 所有用户操作在独立容器中执行,与宿主机隔离
- 文件操作路径验证在
FileManager._validate_path - 上传文件经过
UploadQuarantineManager隔离和扫描 - CSRF 保护在 Web 端启用
- 登录失败次数限制和临时锁定
Known Limitations
- 代码大量由 AI 生成,未达到生产级别
- 容器资源配额依赖 Docker cgroups
- 前端处于改造中,部分功能可能不稳定
- Token 统计基于 tiktoken,可能与实际 API 有偏差
Directory Structure
agents/
├── server/ # Flask 业务主线(chat/task/goal/monitor/auth ...)
├── core/ # 核心终端与工具编排(main_terminal_parts/*)
├── modules/ # 独立功能模块
├── utils/ # 辅助工具
├── config/ # 配置拆分(api/limits/terminal/paths ...,由 __init__ 聚合)
├── static/ # Vue 3 + TS Web 前端
├── cli/ # React + Ink CLI 前端(重写中)
├── docker/ # 容器镜像
├── prompts/ # 系统提示词
├── android-webview-app/ # Android WebView 客户端工程
├── test/ # 测试用例
├── docs/ / doc/ # 设计与发布文档
├── users/ # 用户工作区(运行态,gitignored)
├── data/ # 全局数据(运行态,gitignored)
└── logs/ # 日志文件(运行态,gitignored)
Development Tips
- 修改系统提示词:编辑
prompts/main_system.txt - 调整工具限制:修改
config/limits.py - 容器镜像定制:编辑
docker/terminal.Dockerfile并重新构建 - 前端开发:在项目根目录运行
npm install && npm run dev(build watch) - 查看详细执行流程:监控
logs/debug_stream.log
Permission Mode & Sandbox Execution (2026-05)
完整说明文档:docs/host_sandbox_and_permission_model.md
系统有两套独立但叠加的控制:
权限模式 (Permission Mode)
readonly-run_command在只读沙箱执行;write_file/edit_file等写入类工具直接拒绝approval-run_command先走只读沙箱,权限拒绝(如Operation not permitted/Permission denied)时触发前端审批,通过后仅该次命令以可写沙箱重试auto_approval- 工作区内写入直接执行,工作区外写入进入审批;run_command权限拒绝由后台审批智能体自动审核unrestricted- 不做权限模式拦截,是否沙箱由执行环境决定
执行环境 (Execution Mode)
sandbox(默认)- OS 沙箱执行(macOS:sandbox-exec,Linux:bwrap + seccomp,Windows:WSL2),支持会话级 TTL 自动回退direct -> sandboxdirect- 宿主机直接执行(高风险,仅建议短时使用)
路径授权语义
- 前端路径授权分「可读可写」与「仅可读」:可读集合 = 可读可写 + 仅可读,可写集合 = 可读可写
自动审批智能体
- 配置文件:
config/auto_approval.json(name/url/key/model/extra_params,及timeout_seconds/max_rounds/max_command_timeout) - 调试开关:
modules/approval_agent.py中DEBUG_SAVE_APPROVAL_AGENT_TRANSCRIPT,开启后写入logs/approval_agent/
Android Release Notes (Required for frontend update)
当改动前端并准备发 Android WebView 壳版本时,必须同步完成:
- 更新版本号(
android-webview-app/app/build.gradle.kts)versionCode递增versionName更新
- 更新版本说明(
android-webview-app/APP_CHANGELOG.md)- 新版本条目写在顶部
- 修改完成后提醒用户运行上传脚本:
bash /Users/jojo/Desktop/agents/正在修复中/agents/upload_android_apk.sh
参考文档:doc/android_app_release_and_update.md