Files

T

weichen 2c7f55bfe8 Document svc.sh comprehensively and layer its help system

Why:
svc.sh grew into a three-kind service manager with database operations,
but its only documentation was a flat --help wall of text; the user asked
for a complete usage document and a better help experience.

Evidence:
- docs/svc.md: 14-section manual (prerequisites, quick start, concepts
  and directory layout, per-command reference for service/global/db
  commands, deploy sources, database operations handbook, configuration
  layering, registry fields and event types, safety boundaries, exit
  codes, troubleshooting table, recipe index) — every claim cross-checked
  against the implementation from the previous two rounds.
- Help layering: no-args and -h print a one-screen overview; --help
  renders the header comment reorganized into 7 labeled sections; the new
  "help [topic]" command deep-dives eight topics (model, deploy,
  lifecycle, db, dbops, config, examples, safety); usage errors now show
  the short overview plus a pointer to --help / help / docs/svc.md.
  All topics verified to render; unknown topic exits 2.
- No runtime behavior changed: end-to-end db lifecycle regression
  (create → start → backup → status → stop → rm --purge) passes after the
  refactor.
- Makefile help and README's documentation section point to docs/svc.md.

Impact:
Documentation-only plus display-layer changes; command semantics,
exit codes and file formats are untouched. Maintenance note: behavior
changes must now update both --help and docs/svc.md.

Refs: .task/feature-svc-docs-help.md（任务卡=PR 描述）

2026-09-30 14:29:39 +00:00

2.1 KiB

Raw Permalink Blame History

Agent-System-Dev

Agent-System 的开发集成仓（父仓）：以 submodule 固定全部模块组合，承载跨仓构建、测试编排与原生（非容器）开发环境。非分发单元——发布物在 Agent-System-Releases。

组合结构

modules/core        Agent-System-Core        核心契约（领域模型/事件协议/插件 API/设置与 UI 词汇）
modules/backend     Agent-System-Backend     后端单二进制（内嵌前端与嵌入式 SQLite）
modules/frontend    Agent-System-Frontend    前端（React 19 + Vite + TS）
modules/documents   Agent-System-Documents   系统文档与过程记录
modules/ui          Agent-System-UI          UI 组件库（词汇渲染器/设计令牌/收件箱卡片工作区组件）
deps/development-guidelines                 开发规范（gitlink 固定版本）
deps/agent-native  deps/agent-squad  deps/agent-intent   生态执行/编排/意图
deps/agent-command   Agent-Command           命令总线基础库（spec/注册表/危险分级/审计信封）
deps/error-code-system  deps/logging-system   基础设施
plugins/            示例插件与插件开发参考（P4 起填充）

父仓 gitlink 是各组件源码版本的权威；构建、审核与发布固定提交，不执行 submodule update --remote。

常用命令

make sync     # 物化全部 submodule（递归）
make build    # 构建单二进制 bin/agent-system
make test     # 全量测试
make dev      # 开发模式说明（前后端分离热更新）

约束（全局）

非容器化部署：默认单二进制，必要时拆分多个原生二进制；不发布容器镜像。
依赖方向：frontend→core←backend；插件只依赖 core；生态仓依赖纪律沿用各仓既有约定。
开发规范：deps/development-guidelines（见各仓 AGENTS.md）。

文档

设计方案：modules/documents/docs/proposals/2026-09-29-system-skeleton-design-and-plan.md（含 D1–D16 决策记录）。本机服务管理（后端/前端/数据库部署、生命周期、备份克隆）：docs/svc.md（scripts/svc.sh）。

2.1 KiB Raw Permalink Blame History Unescape Escape

Agent-System-Dev

组合结构

常用命令

约束（全局）

文档

2.1 KiB

Raw Permalink Blame History