8000
Skip to content

Latest commit

 

History

3 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

零基础鸿蒙6软件开发规范指南-Codex版本

语言 / Language: 中文 | English

harmonyos6-0exp-guide-codex 是一个只适用于 Codex 的本地 Skill,用于辅助 HarmonyOS 6 / API 23 原生 ArkTS 应用开发。

本项目帮助 Codex 在鸿蒙应用开发中优先采用华为官方 DevEco CLI、DevEco MCP、官方 HarmonyOS Skills、官方文档检索、ArkTS 检查、构建、安装运行、设备/模拟器、日志和故障排查流程,从而让零基础开发者也能获得更稳定、更接近官方工具链的 AI 辅助开发体验。

本项目是社区 Codex Skill,不是华为官方产品。它不是 DevEco Studio 插件,也不是 Cursor、Claude Code、Trae、通义灵码等其他 AI 编程工具的通用插件。

基本信息

项目 内容
仓库名 harmonyos6-0exp-guide-codex
可安装 Skill 名称 harmonyos6-0exp-guide-codex
中文展示名 零基础鸿蒙6软件开发规范指南-Codex版本
当前版本 0.1.0
适用范围 Codex + HarmonyOS 6 / API 23 / 原生 ArkTS

能力特色

  • 官方工具优先:引导 Codex 先接入 devecocli、DevEco MCP 和官方 HarmonyOS Skills,再进入代码开发。
  • 零基础友好:把项目根目录、模块名、bundleName、入口页面、资源目录、构建、运行、日志、模拟器等概念拆成可执行步骤。
  • UI 规范明确:强调 HarmonyOS 6 原生体验,优先使用 HDS、ArkUI、系统标题栏、系统材质、安全区和自适应布局。
  • 开发流程稳定:要求 Codex 先阅读项目结构和现有代码风格,再进行修改;修改 HarmonyOS 代码后运行官方构建验证。
  • 排障路径清晰:覆盖 ArkTS 语法错误、构建失败、MCP 不可见、设备/模拟器不可用、签名失败和运行日志异常。

适用场景

  • 使用 Codex 新建或接手 HarmonyOS 6 原生 ArkTS 项目。
  • 希望 Codex 先接入 DevEco CLI、DevEco MCP 和官方 HarmonyOS Skills。
  • 需要 Codex 使用官方文档检索、ArkTS 检查、构建、运行和日志命令。
  • 需要建立统一的 HDS / ArkUI / vp / 安全区 / 多设备适配 UI 规范。
  • 需要为小白开发者提供可重复、可验证、可排障的鸿蒙开发流程。

安装前准备

安装这个 Skill 前,请先确认三件事:

  1. 已安装 Codex,并且当前 Codex 支持本地 Skills。
  2. 电脑上可以运行 git
  3. 电脑上可以运行 python3python 或 Windows 的 py -3

这个 Skill 只会让 Codex 获得一套鸿蒙开发工作流。真正开发 HarmonyOS 应用时,还需要另外安装并初始化 DevEco Studio、DevEco SDK 和 Node.js。

macOS 安装方法

方式一:使用 Codex Skill Installer 安装

适合已经安装 Codex,并且本机存在 Codex 系统 Skill 的用户。

  1. 打开 macOS 的“终端”。
  2. 复制下面整段命令并回车:
python3 "${CODEX_HOME:-$HOME/.codex}/skills/.system/skill-installer/scripts/install-skill-from-github.py" \
  --repo luweisong-R/harmonyos6-0exp-guide-codex \
  --path skills/harmonyos6-0exp-guide-codex
  1. 如果命令成功,重启 Codex,或开启一个新的 Codex 线程。
  2. 在 Codex 中输入下面这句话测试:
使用 $harmonyos6-0exp-guide-codex 检查当前 HarmonyOS 项目的开发环境。

方式二:macOS 手动安装

如果 Skill Installer 不可用,可以手动复制 Skill 文件夹。

cd ~/Downloads
git clone https://github.com/luweisong-R/harmonyos6-0exp-guide-codex.git
mkdir -p "${CODEX_HOME:-$HOME/.codex}/skills"
cp -R harmonyos6-0exp-guide-codex/skills/harmonyos6-0exp-guide-codex \
  "${CODEX_HOME:-$HOME/.codex}/skills/"

确认安装结果:

ls "${CODEX_HOME:-$HOME/.codex}/skills/harmonyos6-0exp-guide-codex/SKILL.md"

如果能看到 SKILL.md 文件,说明复制成功。然后重启 Codex,或开启一个新的 Codex 线程。

Windows 安装方法

Windows 用户建议使用 PowerShell,不建议使用传统 CMD。

方式一:使用 Codex Skill Installer 安装

  1. 打开 PowerShell。
  2. 先确认 Python 和 Git 是否可用:
python --version
git --version

如果 python --version 不可用,可以尝试:

py -3 --version
  1. 在 PowerShell 中执行:
$CodexHome = if ($env:CODEX_HOME) { $env:CODEX_HOME } else { Join-Path $env:USERPROFILE ".codex" }
python "$CodexHome\skills\.system\skill-installer\scripts\install-skill-from-github.py" --repo luweisong-R/harmonyos6-0exp-guide-codex --path skills/harmonyos6-0exp-guide-codex

如果上一条命令提示找不到 python,改用:

$CodexHome = if ($env:CODEX_HOME) { $env:CODEX_HOME } else { Join-Path $env:USERPROFILE ".codex" }
py -3 "$CodexHome\skills\.system\skill-installer\scripts\install-skill-from-github.py" --repo luweisong-R/harmonyos6-0exp-guide-codex --path skills/harmonyos6-0exp-guide-codex
  1. 安装完成后重启 Codex,或开启一个新的 Codex 线程。
  2. 在 Codex 中输入下面这句话测试:
使用 $harmonyos6-0exp-guide-codex 检查当前 HarmonyOS 项目的开发环境。

方式二:Windows 手动安装

如果 Skill Installer 不可用,可以手动复制。

cd $env:USERPROFILE\Downloads
git clone https://github.com/luweisong-R/harmonyos6-0exp-guide-codex.git
$CodexHome = if ($env:CODEX_HOME) { $env:CODEX_HOME } else { Join-Path $env:USERPROFILE ".codex" }
$SkillRoot = Join-Path $CodexHome "skills"
New-Item -ItemType Directory -Force -Path $SkillRoot | Out-Null
Copy-Item -Recurse -Force ".\harmonyos6-0exp-guide-codex\skills\harmonyos6-0exp-guide-codex" $SkillRoot

确认安装结果:

Test-Path "$SkillRoot\harmonyos6-0exp-guide-codex\SKILL.md"

如果输出 True,说明复制成功。然后重启 Codex,或开启一个新的 Codex 线程。

Linux 安装方法

如果使用的是支持本地 Skills 的 Linux 版 Codex 或 Linux 环境中的 Codex,可参考以下方式。

方式一:使用 Codex Skill Installer 安装

python3 "${CODEX_HOME:-$HOME/.codex}/skills/.system/skill-installer/scripts/install-skill-from-github.py" \
  --repo luweisong-R/harmonyos6-0exp-guide-codex \
  --path skills/harmonyos6-0exp-guide-codex

安装完成后重启 Codex,或开启一个新的 Codex 线程。

方式二:Linux 手动安装

cd ~/Downloads
git clone https://github.com/luweisong-R/harmonyos6-0exp-guide-codex.git
mkdir -p "${CODEX_HOME:-$HOME/.codex}/skills"
cp -R harmonyos6-0exp-guide-codex/skills/harmonyos6-0exp-guide-codex \
  "${CODEX_HOME:-$HOME/.codex}/skills/"

确认安装结果:

test -f "${CODEX_HOME:-$HOME/.codex}/skills/harmonyos6-0exp-guide-codex/SKILL.md" && echo "installed"

看到 installed 后,重启 Codex,或开启一个新的 Codex 线程。

使用方式

在 Codex 中显式引用 Skill:

使用 $harmonyos6-0exp-guide-codex 为当前 HarmonyOS 6 ArkTS 项目完成首次接入:检查项目结构和 Git 状态,安装或确认 DevEco CLI、DevEco MCP 和官方 HarmonyOS Skills,然后运行官方构建命令。

英文提示词也可使用:

Use $harmonyos6-0exp-guide-codex to set up Codex for this HarmonyOS 6 ArkTS project, install official DevEco CLI/MCP/Skills, then run the first build.

更多提示词示例见 examples/prompts.md

推荐工作流

该 Skill 会引导 Codex 按以下顺序工作:

  1. 检查项目根目录、Git 状态、模块配置、源码目录、资源目录和现有代码风格。
  2. 安装或确认 @deveco/deveco-cli
  3. 为 Codex 配置 DevEco MCP。
  4. 安装官方 HarmonyOS Skills。
  5. 在不确定 ArkUI、HDS、API、权限、系统能力、材质或构建配置时,先查询官方文档。
  6. 可用时使用 DevEco MCP 的 ArkTS 检查能力。
  7. 使用 devecocli build 验证 HarmonyOS 代码修改。
  8. 存在设备或模拟器时,使用 devecocli run 安装并运行应用。
  9. 需要运行诊断时,使用 devecocli log 获取日志。

UI 设计重点

本 Skill 特别强调 HarmonyOS 原生 UI,而不是 Android 式或通用 Web 式界面:

  • 优先使用 HDS 导航、页签、弹窗、标题栏和系统材质。
  • 优先使用 ArkUI 自适应布局能力,例如 layoutWeightBlankScrollGridFlex
  • 设计稿中的视觉像素默认按 ArkUI vp 理解,除非 API 明确要求物理像素。
  • 关注状态栏、挖孔、底部手势区、折叠屏、平板、深色模式和多设备适配。
  • 普通列表、设置项和数据容器优先采用轻量透明材质或磨砂层次,而不是厚重纯白/纯灰实底。

更新已安装的 Skill

macOS / Linux

rm -rf "${CODEX_HOME:-$HOME/.codex}/skills/harmonyos6-0exp-guide-codex"
python3 "${CODEX_HOME:-$HOME/.codex}/skills/.system/skill-installer/scripts/install-skill-from-github.py" \
  --repo luweisong-R/harmonyos6-0exp-guide-codex \
  --path skills/harmonyos6-0exp-guide-codex

Windows PowerShell

$CodexHome = if ($env:CODEX_HOME) { $env:CODEX_HOME } else { Join-Path $env:USERPROFILE ".codex" }
Remove-Item -Recurse -Force "$CodexHome\skills\harmonyos6-0exp-guide-codex" -ErrorAction SilentlyContinue
python "$CodexHome\skills\.system\skill-installer\scripts\install-skill-from-github.py" --repo luweisong-R/harmonyos6-0exp-guide-codex --path skills/harmonyos6-0exp-guide-codex

更新后重启 Codex。

常见问题

安装后 Codex 没有识别这个 Skill

先确认文件是否存在:

ls "${CODEX_HOME:-$HOME/.codex}/skills/harmonyos6-0exp-guide-codex/SKILL.md"

Windows PowerShell:

$CodexHome = if ($env:CODEX_HOME) { $env:CODEX_HOME } else { Join-Path $env:USERPROFILE ".codex" }
Test-Path "$CodexHome\skills\harmonyos6-0exp-guide-codex\SKILL.md"

如果文件存在但 Codex 仍未识别,请重启 Codex,或开启一个新的 Codex 线程。

提示找不到 Python

macOS / Linux 通常使用:

python3 --version

Windows 可尝试:

python --version
py -3 --version

如果这些命令都不可用,需要先安装 Python。

提示找不到 Git

需要先安装 Git。安装后重新打开终端或 PowerShell,再执行:

git --version

这个 Skill 能不能用于其他 AI 编程工具

不能直接使用。本项目是 Codex Skill,目录结构、触发方式和安装路径都是为 Codex 设计的。其他 AI 编程工具需要单独适配。

仓库结构

.
├── README.md
├── README.en.md
├── VERSION
├── LICENSE
├── examples/
│   └── prompts.md
└── skills/
    └── harmonyos6-0exp-guide-codex/
        ├── SKILL.md
        ├── agents/
        │   └── openai.yaml
        └── references/
            ├── beginner-workflow.md
            ├── build-run-debug.md
            ├── setup-devco-cli.md
            ├── troubleshooting.md
            └── ui-standards.md

校验

可使用 Codex Skill Creator 的校验脚本检查 Skill 结构:

python3 "${CODEX_HOME:-$HOME/.codex}/skills/.system/skill-creator/scripts/quick_validate.py" \
  skills/harmonyos6-0exp-guide-codex

期望输出:

Skill is valid!

许可证

MIT License. See LICENSE.

About

零基础鸿蒙6软件开发规范指南(Codex Skill),优先接入 DevEco CLI、MCP、官方 Skills 与 HarmonyOS 原生 UI 工作流。

Topics

Resources

Stars

12 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

0