arc-kit Usage Guide / arc-kit 使用指南
Follow the steps below; keep answers short and accurate.
按下面顺序工作,保持回答短而准。
Information Sources / 信息源
- Primary source:
README.md. 以README.md为主。 - Interactive/non-interactive, JSON, exit codes:
README.md#interaction-and-automation-design. 交互/非交互、JSON、退出码看README.md#interaction-and-automation-design。 - If docs conflict with implementation, code is authoritative, especially
arc-cli/src/cli.rs,arc-cli/src/commands/*,arc-core/src/agent/mod.rs. 若文档与实现冲突,以代码为准,尤其是arc-cli/src/cli.rs、arc-cli/src/commands/*、arc-core/src/agent/mod.rs。
Check First / 先查什么
- Overview / 总览:
arc status - provider:
arc providerorarc provider list/ provider:arc provider或arc provider list - Installed skills / 已装 skill:
arc skill list --installed - market:
arc market list
Key Semantics / 必须记住的语义
- Bare
arconly printsarc --help, notarc status. 裸arc只会打印arc --help,不等于arc status。 --format jsontakes precedence over TTY.--format json优先于 TTY。- Write commands in non-interactive environments require explicit parameters; wizards are not available. 写入类命令在非交互环境必须给显式参数,不能指望向导。
- For write-command JSON, check
okin addition to exit code. 对写入类 JSON,除了退出码,还要检查ok。 arc versiondoes not support JSON.arc version不支持 JSON。arc project editis interactive-only; non-interactive or--format jsonreturns a failedWriteResultwithout opening an editor.arc project edit只在交互式终端可用;非交互或--format json只返回失败的WriteResult,不会执行编辑。- MCP and subagent management have been removed; do not suggest
arc mcp,arc subagent,[mcps], or[subagents]. MCP 与 subagent 管理功能已移除;不要建议arc mcp、arc subagent、[mcps]或[subagents]。
Common Project-Level Pitfalls / 容易答错的项目级行为
- Project-level skills are managed by
arc.toml+arc project apply, not by globalarc skill install. 项目级 skill 由arc.toml+arc project apply管理,不等于全局arc skill install。 - Codex project-level skill path is
.codex/skills/. Codex 的项目级 skill 路径是.codex/skills/。 - OpenClaw does not support project-level skills. OpenClaw 不支持项目级 skill。
arc.tomlonly supportsversion,provider,skills, andmarkets.arc.toml只支持version、provider、skills和markets。
Capability Quick Reference / 能力速查
- project skill: Supported by Claude / Codex / Cursor / OpenCode / Gemini / Kimi; not supported by OpenClaw. Claude / Codex / Cursor / OpenCode / Gemini / Kimi 支持;OpenClaw 不支持。
- Key project paths / 关键项目路径:
Codex project skill in
.codex/skills/; Claude project skill in.claude/skills/; Cursor project skill in.cursor/skills/; OpenCode project skill in.opencode/skills/; Gemini project skill in.gemini/skills/; Kimi project skill in.kimi/skills/. Codex project skill 在.codex/skills/; Claude project skill 在.claude/skills/; Cursor project skill 在.cursor/skills/; OpenCode project skill 在.opencode/skills/; Gemini project skill 在.gemini/skills/; Kimi project skill 在.kimi/skills/。
Common Questions / 常见问法
"Why didn't
arc project applytake effect?" Checkarc status, verifyarc.tomlexists in the repo, confirm the target agent supports project-level skills, and check whether--agent/--all-agentswas specified. 「为什么arc project apply没生效」 先看arc status,再看仓库里是否真的有arc.toml,再核对目标 agent 是否支持项目级 skill,以及命令是否带了--agent/--all-agents。"Why wasn't the skill installed?" Distinguish global vs project-level; check
arc skill list --installedfor global,arc statusand in-repo paths for project-level. 「为什么 skill 没装上」 先区分全局还是项目级;全局看arc skill list --installed,项目级看arc status和对应仓库内路径。"Why is the provider wrong after switching?" Check
arc provider list/arc provider test, then verify the agent's config file and provider type differences. 「为什么 provider 切换后不对」 先看arc provider list/arc provider test,再核对对应 agent 的配置文件和 provider 类型差异。"Why can't my script get results?" Use
--format jsonand check the write-command JSONokfield, not just the exit code. 「为什么脚本里拿不到结果」 优先改用--format json,并提醒用户读取写入类 JSON 的ok字段,而不是只看退出码。
Common Failure Signals / 常见失败信号
- Missing required params in non-interactive mode: fails directly without entering a wizard. 非交互环境缺少必要参数:这类通常直接失败,不会进入向导。
arc project edit: non-interactive and JSON paths never open an editor, only return failure.arc project edit:非交互和 JSON 路径都不会打开编辑器,只会返回失败结果。arc version: no JSON output; do not let users rely on--format json.arc version:没有 JSON 输出,不要让用户依赖--format json。- User manually modified agent native directories: do not assume arc fully recognizes or maintains them; distinguish "arc-tracked installs" from "manually placed content". 用户手工改 agent 原生目录:不要默认 arc 一定会完整识别或维护;先区分「由 arc 跟踪的安装」与「手工放进去的内容」。
arc market update: only maintains arc-tracked global skill installs; do not claim it cleans up all same-named skills across agent directories.arc market update:只会维护 arc 已追踪的全局 skill 安装,不要误答成「会清理所有 agent 目录里的同名 skill」。