@gitruck/cli 1.2.13 → 1.2.14

package/docs/development.en.md

@@ -0,0 +1,47 @@
+# Development and contributions
+
+[Back to README](../README.en.md) · [Command reference](reference.en.md) · [简体中文](development.md)
+
+## Local development
+
+The CLI runtime requires Node.js ≥ 20.6. Source development and builds use Bun.
+
+```bash
+git clone https://github.com/Gitruck/cli.git
+cd cli
+bun install
+bun run src/index.ts --help
+npm run typecheck
+bun run build
+```
+
+The public repository supports reading, developing and building the CLI. `test/` and `openspec/` are private submodules requiring maintainer access. Public contributors do not need a recursive clone; authorized maintainers run the complete test suite.
+
+## Repository layout
+
+```text
+src/index.ts       Command entry point
+src/commands/      CLI commands
+src/lib/           Cloud calls, media processing, project assembly and rendering
+skills/            Bundled Agent Skills
+contracts/         Open project and motion graphics contracts
+docs/              Workflow, configuration, command and development references
+assets/            README artwork
+AGENT.md           Portable agent playbook
+```
+
+Add commands through registration functions in `src/commands/` and wire them into `src/index.ts`. Toolbox additions should reuse existing descriptors and runners where applicable. `src/commands/skills.ts` owns the bundled Skill list; see the [reference](reference.en.md) for details.
+
+## Documentation and checks
+
+- README presents the product and onboarding. Maintain parameters, configuration and full explanations in `docs/reference.md` / `docs/reference.en.md`.
+- Update both READMEs and corresponding bilingual documents together. Preserve command names, flags, fields and artifact filenames; keep example commands identical.
+- Use publicly accessible images or files in `assets/`. Keep examples traceable and large videos out of the npm package.
+- Maintainers run `npm test`, which builds and uses Node's test runner. Do not substitute `bun test`. Documentation-only changes should at least run the relevant guards and check links and rendering.
+- Check `npm pack --dry-run` when moving bundled documentation so it remains in the package.
+
+## Contributing
+
+Use [Issues](https://github.com/Gitruck/cli/issues) to describe problems, use cases or behavior you would like improved. Explain changes and validation in your PR. Do not include API keys, personal configuration, media paths, generated outputs or private submodule contents.
+
+See [contracts](../contracts/README.md) for interfaces and [AGENT.md](../AGENT.md) for agent usage.

package/docs/development.md

@@ -0,0 +1,47 @@
+# 开发与贡献
+
+[返回首页](../README.md) · [命令参考](reference.md) · [English](development.en.md)
+
+## 本地开发
+
+CLI 运行时需要 Node.js ≥ 20.6；源码开发与构建使用 Bun。
+
+```bash
+git clone https://github.com/Gitruck/cli.git
+cd cli
+bun install
+bun run src/index.ts --help
+npm run typecheck
+bun run build
+```
+
+公共仓库可用于阅读、开发和构建 CLI。`test/` 与 `openspec/` 是需要维护者权限的私有子模块，公开贡献者无需递归拉取它们；完整测试由有权限的维护者运行。
+
+## 项目结构
+
+```text
+src/index.ts       命令入口
+src/commands/      CLI 命令
+src/lib/           云端调用、素材处理、工程装配与渲染
+skills/            随包 Agent Skills
+contracts/         工程与动态图等开放契约
+docs/              工作流、配置、命令和开发参考
+assets/            README 配图
+AGENT.md           可移植 Agent 操作手册
+```
+
+新增命令在 `src/commands/` 中提供注册函数，并在 `src/index.ts` 接入；工具族优先复用已有描述器与执行器。随包 Skills 的权威清单在 `src/commands/skills.ts`，详细名单见[参考文档](reference.md)。
+
+## 文档与校验
+
+- README 负责产品展示和上手；参数、配置与完整操作解释维护在 `docs/reference.md` / `docs/reference.en.md`。
+- 两份 README 和对应双语文档同步更新。命令名、参数、字段与产物文件名保持原样；示例命令保持一致。
+- 配图使用公开可访问资源，或放入 `assets/`；案例保持可追溯，不将大视频打包进 npm。
+- 维护者运行 `npm test`（构建后通过 Node 测试），不要用 `bun test` 代替。纯文档变更至少运行相关文档守卫、检查链接和展示效果。
+- 修改公开随包文档时，检查 `npm pack --dry-run` 的文件清单，避免移动后漏包。
+
+## 提交贡献
+
+通过 [Issues](https://github.com/Gitruck/cli/issues)描述问题、使用场景或希望改进的行为。提交 PR 时说明变更与验证方式。不要提交 API Key、个人配置、素材路径、生成产物或私有子模块的内容。
+
+接口约定见 [contracts](../contracts/README.md)，Agent 使用方式见 [AGENT.md](../AGENT.md)。