# ohos-ai-dev-kit

**Repository Path**: sinall/ohos-ai-dev-kit

## Basic Information

- **Project Name**: ohos-ai-dev-kit
- **Description**: No description available
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-15
- **Last Updated**: 2026-07-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ohos-ai-dev-kit

面向 OpenHarmony 团队的轻量 Coding Agent Harness。它让 Codex、Claude Code、OpenCode 等命令行工具共享项目规则、可复用 Skill、统一任务入口和确定性验证，同时保留人工需求决策、代码评审与发布控制。

[English](README.en.md)

## v0.1 能做什么

- 使用锁定版本和 SHA-256 安全安装 `just`；
- 只读检查 Python、Git、AI CLI 和配套工具状态；
- 为 Codex、Claude Code、OpenCode 生成一致的项目规则；
- 提供可扩展的 OpenHarmony 项目 Profile，内置 ArkUI Lite 示例且不修改源码子仓库；
- 提供需求分析、实施计划、代码审查、完成验证和交付文档 5 个基础 Skill；
- 使用 `just verify` 统一执行语法检查、测试和环境门禁。

本项目不提供统一模型网关，不保存个人提示词或 API Key，也不自动提交、推送、合并和发布代码。

## 五分钟开始

环境要求：Python 3.8+、Git，以及 Linux 或 macOS 的 x86_64/aarch64 环境。

建议将本仓库作为独立工具仓库，克隆到 OpenHarmony Repo 工作区之外或同级，并在 `ohos-ai-dev-kit` 目录执行以下命令。这样可避免根目录递归搜索、CodeGraph 或 AI 上下文索引误收录工具代码。

OpenHarmony 是 Repo 管理的多仓库工作区，因此也可以把本仓库放在 Repo 工作区根目录下的非托管目录中，这通常不会影响各子仓库开发和提交；但该目录不能与 manifest 管理路径重叠，并应加入 CodeGraph、IDE 和其他递归索引工具的排除列表。

```bash
git clone https://gitee.com/sinall/ohos-ai-dev-kit.git
cd ohos-ai-dev-kit

# 只读检查；首次执行可能因尚未安装锁定版 just 而返回非零
python3 bootstrap.py --check

# 安装锁定版 just 到 ~/.local/bin
python3 bootstrap.py --yes
export PATH="$HOME/.local/bin:$PATH"

just doctor
just verify
```

查看所有任务：

```bash
just --list
```

完整步骤见[快速开始](docs/quick-start.md)。

## 项目 Profile 接入示例

以下命令仍从 `ohos-ai-dev-kit` 目录执行；`--workspace` 指向包含 `.repo/` 的 OpenHarmony Repo 工作区根目录。先预览内置的 ArkUI Lite Profile，不写入工作区：

```bash
python3 bootstrap.py project init \
  --profile arkui-lite \
  --workspace /path/to/openharmony \
  --check
```

确认列表后去掉 `--check`。公共规则、OpenHarmony 多仓库规则和项目专属规则会分别生成；层间同名文件或工作区已有不同文件都会报告冲突，不会静默覆盖。Profile 中的 build/test 任务默认拒绝运行，项目维护者必须先填入经过验证的真实命令。新增项目只需在 `profiles/<name>/` 提供项目声明、规则和任务文件，无需修改 Python 枚举。

## 结构

```text
bootstrap.py       安装、诊断和项目初始化入口
versions.lock      工具版本、下载地址和 SHA-256
justfile           仓库统一任务入口
rules/             安全、编码、测试和 Git 公共规则
skills/            五个可复用 Agent Skill
templates/         公共规则与 OpenHarmony 多仓库适配层
profiles/          可扩展项目 Profile（内置 ArkUI Lite）
src/               无第三方运行时依赖的 Python 实现
tests/             unittest 自动测试
docs/              使用、维护、设计和实施文档
```

`just` 只负责任务发现与编排，不替代 HB、GN、Ninja、Repo 或项目原有测试系统。Python 只处理安装校验、环境诊断和安全模板更新等复杂逻辑。

## 使用边界

- 正式需求、当前源码、真实构建和测试结果高于 AI 推断与 CodeGraph。
- AI 生成代码必须经过人工评审，并使用与人工代码相同的验证标准。
- 未经明确授权，Agent 不执行 commit、push、merge、release 或破坏性 Git 操作。
- CodeGraph 是辅助索引；与当前源码不一致时以源码为准。
- OpenSpec 对中大型变更推荐使用，小型明确修复不强制。

团队实践见[团队使用指南](docs/team-guide.md)，工具升级与发布见[维护指南](docs/maintainer-guide.md)。

## 开发与验证

```bash
just test
just lint
just content-check
just verify
```

项目设计与实施记录：

- [v0.1 设计](docs/superpowers/specs/2026-07-15-ohos-ai-dev-kit-v0.1-design.md)
- [v0.1 实施计划](docs/superpowers/plans/2026-07-15-ohos-ai-dev-kit-v0.1.md)

## 贡献

请在功能分支中提交小而可验证的改动，运行 `just verify` 后创建 Pull Request。公共权限规则、下载与安装逻辑需要额外关注安全边界和向后兼容。

## 许可证

[Apache License 2.0](LICENSE)