弧形状
ArcShape是一个npm-install可定义的CLI,以及用于创建和维护Markdown架构文档的单独管理的代理技能包 弧形42其生成的读者网站是为技术和非技术读者设计的.
浏览 ArcShape 建筑网站。 。 。 .
开始吧
在项目寄存器中安装 ArcShape , 并带有 Node.js 22 或 更新并运行 :
npm install --save-dev @arcshape/cli
npx arcshape init
arcshape init 创建 docs/architecture/ 带有导航读取器和十二个 NN-slug/README.md 弧形42节。 额外的Markdown文件可以活在自有的段目录中,并作为辅助材料提供. 遗产平地 NN-slug.md 迁移时布局仍然可以读取。 然后提供检测到的代理供应商和能力。 选择 --no-agents 只有CLI的设置。 在非交互式弹壳上,说明选择和确认:
npx arcshape init --providers codex,claude --dry-run
npx arcshape init --providers codex,claude --yes
npx arcshape init --no-agents --yes
默认安装范围是当前寄存器. 使用 --scope user 将安装在您的家目录中. --providers 接受 codex, (中文(简体) ), claude, (中文(简体) ), cursor, (中文(简体) ), windsurf, (中文(简体) ), gemini, (中文(简体) ), opencode,以及 copilot· ; --capabilities 接受逗号分隔名称,例如 arc-adr,arc-c4没有 --capabilities,所有4种技能都被选中. 被检测的提供者是建议,从未被默默选中.
每个峡谷 SKILL.md 遵循便携式代理技能格式。 提供者中性技能生活在 .agents/skills/ 用于Codex,Cursor,Windsurf/Cascade,双子座CLI,OpenCode,和GitHub副驾驶. Claude 代码使用 .claude/skills/。 。 。 . arcshape agents detect 报告来自 PATH 和薄弱的提供方专用仓库标记; 共享 .agents/skills/ 目录含糊不清,无法识别代理。 一些提供者发现了共享和克洛德的根,因此选择克洛德和一个共享路径提供者可能会两次暴露出同样的技能. Windsurf文档目前重定向到 Devin 桌面文档; ArcShape 使用已记录的共享技能路径,并将该提供者的相容性视为临时.
设置后管理能力 arcshape agents detect, (中文(简体) ), arcshape agents list, (中文(简体) ), arcshape agents install, (中文(简体) ), arcshape agents update,以及 arcshape agents uninstall。 。 。 . install 将选中的提供者和能力添加到当前管理的集中; 它不会删除先前的选择 . update 刷新管理集,以及 uninstall 删除所有未修改的管理文件 。 例如:
npx arcshape agents install --providers codex,claude --capabilities arc-adr,arc-c4 --dry-run
npx arcshape agents install --providers codex,claude --capabilities arc-adr,arc-c4 --yes
npx arcshape agents update --yes
npx arcshape agents uninstall --yes
ArcShape 记录拥有文件散列 .arcshape/agent-capabilities.json (或 ~/.arcshape/agent-capabilities.json 用户范围)。 更新只替换未修改的文件 ArcShape 管理; 未安装只删除未修改的管理文件 。 已编辑和未跟踪的文件得到保存和报告,冲突产生非零退出状态. 在确认的代理能力操作中,提供了包版0.1.1中准确的未变的助理文件取出;所编辑的遗留文件仍未被更改. Npm包装代理能力船并安装下线. ArcShape不安装市场插件,不联系代理服务,也不执行能力脚本.
CLI 提供寄存器设置(init(b) 临时证据全程簿记(session), arc42 Markdown结构,本地链接和可选产品元件引用验证(validate), Obsidian 和 Collection 同步(sync),以及自成一体的读者网站(site build) (中文(简体) ). 单独安装的技能包括倒向工程、arc42作者、ADRs、C4图表和文档连接.
验证arc42结构和本地链接. 添加 --citations 当寄存器在 docs/product/model数字 :
npx arcshape validate --links --citations
引用验证使用存储器安装 @prodshape/cli;当产品形状模型出现时安装. 没有模型,引用验证报告为跳过. Stale 引用显示为警告, 而未解决引用或缺失的本地 CLI 失败验证 .
开始本地分析会话, 并要求其下一轮设定范围的证据 :
npx arcshape session start
npx arcshape session next
将峡谷马克德复制到 Obsidian 金库:
npx arcshape sync obsidian --vault ~/Documents/ObsidianVault --include docs/architecture/09-architecture-decisions --dry-run
npx arcshape sync obsidian --vault ~/Documents/ObsidianVault --include docs/architecture/09-architecture-decisions
同步存储了导出注释旁的本地列表, 仅在副本仍然匹配上一个 ArcShape 版本时更新副本, 并将本地编辑报告为冲突 .
要将架构作为一个索引发布,每个弧度42节各有1个子页,选择一个相会母页,并在环境变量中设置证书. 先预览页面计划 :
[email protected] CONFLUENCE_API_TOKEN=... \
npx arcshape sync confluence \
--base-url https://example.atlassian.net/wiki \
--space-id 12345 --parent-id 123456 --title-prefix MyProject \
--include docs/architecture/09-architecture-decisions --dry-run
删除 --dry-run 以创建或更新页面。 ArcShape 记录了本地基线 : .arcshape/confluence-sync/; 后在远程编辑上停止运行到管理页面. 单页目标,使用 --page-id <id> 改为 --space-id 财务报告和审定财务报表 --parent-id。 。 。 .
会话工具盘点文件而不通过编程语言进行选择,并尊重root和嵌入 .gitignore 规则,包括否定。 它记录人类或AI工作流程的分类和笔记;它不将发现本身读入建筑主张.
项目基础
- 经核准的产品定义载于
docs/product/model并使用 产品形状。 。 。 . - 建筑文件将生活在
docs/architecture跟踪 弧形42。 。 。 . - 打开Spec 用于临时交付规划,而不是作为产品或建筑真相的来源.
- 读取 工程生命周期 准备、审查和合并预期.
开发设置
npm ci
被钉住 产品形状 财务报告和审定财务报表 打开Spec 国家领导才能作为地方发展依赖而安装。 使用 npx prodshape <command> 或运行它们的软件包脚本;不需要全局安装.
追踪到的Codex 克劳德, 产品形状,以及 打开Spec 这一发展储存库已经存在一体化。 仅在有意重生成或刷新相应集成文件时运行 :
npm run product:init
npm run openspec:init
初始质量基准在 工程生命周期。 。 。 . npm run build 编译寄存器帮助脚本;不是ArcShape CLI构建.
捐款
开始于 捐款指南. 对于非三角工作,在规划实施前开放或完善GitHub问题.
发行准备,第一个npm出版,以及后来值得信赖的出版都记录在 重放弧形状。 。 。 .
许可证
ArcShape根据以下规定获得许可证: Apache 许可证,2.0版本,该许可证用于: 产品形状。 。 。 .