Skip to content

Commit 07371f4

Browse files
committed
docs: add skills.sh install guidance
1 parent fe3c20d commit 07371f4

4 files changed

Lines changed: 111 additions & 12 deletions

File tree

README.md

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
语言:中文 | [English](./README_en.md)
66

77
[![release](https://img.shields.io/badge/release-v1.3.23-1f6feb?style=flat-square)](https://github.com/linhay/harmony-next.skills/releases/tag/v1.3.23)
8+
[![skills.sh](https://skills.sh/b/linhay/harmony-next.skills)](https://skills.sh/linhay/harmony-next.skills)
89
[![readme](https://img.shields.io/badge/readme-English-0f766e?style=flat-square)](./README_en.md)
910
![docs](https://img.shields.io/badge/docs-3,693%20markdown%20files-7c3aed?style=flat-square)
1011
![js-ets](https://img.shields.io/badge/JsEtsAPIReference-3,666%20files-b45309?style=flat-square)
@@ -144,6 +145,32 @@ SKILL.md
144145

145146
## 快速接入
146147

148+
### Vercel Labs skills CLI(推荐通用方式)
149+
150+
本仓库可被 [`vercel-labs/skills`](https://github.com/vercel-labs/skills) 直接发现并安装:
151+
152+
```bash
153+
npx skills add linhay/harmony-next.skills --skill harmony-next
154+
```
155+
156+
只查看可用技能:
157+
158+
```bash
159+
npx skills add linhay/harmony-next.skills --list
160+
```
161+
162+
安装到 Codex 的全局技能目录(非交互,复制文件而不是软链):
163+
164+
```bash
165+
npx skills add linhay/harmony-next.skills --skill harmony-next -a codex -g -y --copy
166+
```
167+
168+
相关目录与官方示例仓库:
169+
170+
- [`skills.sh`](https://skills.sh/)`vercel-labs/skills` 使用的公开目录与安全评分入口;本仓库页面是 [`skills.sh/linhay/harmony-next.skills`](https://skills.sh/linhay/harmony-next.skills)
171+
- [`vercel-labs/agent-skills`](https://github.com/vercel-labs/agent-skills):Vercel 官方维护的 Agent Skills 集合。
172+
- [`anthropics/skills`](https://github.com/anthropics/skills):Anthropic 的公开 Agent Skills 仓库,包含 Claude skills 示例、规范与模板。
173+
147174
### Gemini CLI
148175

149176
```bash
@@ -152,10 +179,15 @@ gemini skills install https://github.com/linhay/harmony-next.skills --path harmo
152179

153180
### Claude Code
154181

155-
1. 下载本仓库中的技能目录。
156-
2. 按需压缩技能文件夹。
157-
3. 在 Claude.ai 的 `Settings > Capabilities > Skills` 中上传。
158-
4. 或直接放进你的 Claude Code 技能目录。
182+
推荐使用 `vercel-labs/skills` CLI 安装到 Claude Code:
183+
184+
```bash
185+
npx skills add linhay/harmony-next.skills --skill harmony-next -a claude-code -g -y --copy
186+
```
187+
188+
这会把技能安装到 Claude Code 的全局技能目录(当前 CLI 行为是 `~/.claude/skills/harmony-next`)。
189+
190+
Claude.ai 网页端仍可使用 release 中的 `harmony-next.skill.zip`:在 `Settings > Capabilities > Skills` 中上传。
159191

160192
如果你只是想把仓库作为项目上下文附加:
161193

@@ -166,11 +198,17 @@ claude --add-dir /path/to/harmony-next.skills/harmony-next
166198

167199
### Codex
168200

201+
推荐使用 `vercel-labs/skills` CLI 安装到 Codex:
202+
203+
```bash
204+
npx skills add linhay/harmony-next.skills --skill harmony-next -a codex -g -y --copy
205+
```
206+
169207
官方 Codex Agent Skills 文档说明:skill 是可复用工作流的创作格式;直接 skill 目录用于本地创作与发现;可安装分发单元是 Codex plugin。
170208

171209
官方文档:<https://developers.openai.com/codex/skills>
172210

173-
本仓库当前还没有打包成 Codex plugin,因此 Codex 的官方接入方式是放入官方 skill 扫描路径。
211+
本仓库当前还没有打包成 Codex plugin。如果不使用 `npx skills`,可手动放入官方 skill 扫描路径。
174212

175213
可选官方路径:
176214

README_en.md

Lines changed: 43 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ An offline HarmonyOS NEXT reference skill for coding agents such as Gemini CLI,
55
Language: English | [中文](./README.md)
66

77
[![release](https://img.shields.io/badge/release-v1.3.23-1f6feb?style=flat-square)](https://github.com/linhay/harmony-next.skills/releases/tag/v1.3.23)
8+
[![skills.sh](https://skills.sh/b/linhay/harmony-next.skills)](https://skills.sh/linhay/harmony-next.skills)
89
[![readme](https://img.shields.io/badge/readme-%E4%B8%AD%E6%96%87-0f766e?style=flat-square)](./README.md)
910
![docs](https://img.shields.io/badge/docs-3,693%20markdown%20files-7c3aed?style=flat-square)
1011
![js-ets](https://img.shields.io/badge/JsEtsAPIReference-3,666%20files-b45309?style=flat-square)
@@ -144,6 +145,32 @@ Usage rules:
144145

145146
## Quick Start
146147

148+
### Vercel Labs skills CLI (recommended generic path)
149+
150+
This repository can be discovered and installed directly by [`vercel-labs/skills`](https://github.com/vercel-labs/skills):
151+
152+
```bash
153+
npx skills add linhay/harmony-next.skills --skill harmony-next
154+
```
155+
156+
List available skills without installing:
157+
158+
```bash
159+
npx skills add linhay/harmony-next.skills --list
160+
```
161+
162+
Install globally for Codex non-interactively, copying files instead of symlinking:
163+
164+
```bash
165+
npx skills add linhay/harmony-next.skills --skill harmony-next -a codex -g -y --copy
166+
```
167+
168+
Related directories and official example repositories:
169+
170+
- [`skills.sh`](https://skills.sh/): the public directory and security-assessment entry used by `vercel-labs/skills`; this repository's page is [`skills.sh/linhay/harmony-next.skills`](https://skills.sh/linhay/harmony-next.skills).
171+
- [`vercel-labs/agent-skills`](https://github.com/vercel-labs/agent-skills): Vercel's official Agent Skills collection.
172+
- [`anthropics/skills`](https://github.com/anthropics/skills): Anthropic's public Agent Skills repository, including Claude skill examples, the spec, and a template.
173+
147174
### Gemini CLI
148175

149176
```bash
@@ -152,10 +179,15 @@ gemini skills install https://github.com/linhay/harmony-next.skills --path harmo
152179

153180
### Claude Code
154181

155-
1. Download the skill directory from this repository.
156-
2. Zip it if needed.
157-
3. Upload it in Claude.ai via `Settings > Capabilities > Skills`.
158-
4. Or place it in your Claude Code skills directory.
182+
Recommended Claude Code install via the `vercel-labs/skills` CLI:
183+
184+
```bash
185+
npx skills add linhay/harmony-next.skills --skill harmony-next -a claude-code -g -y --copy
186+
```
187+
188+
This installs the skill into Claude Code's global skills directory (current CLI behavior: `~/.claude/skills/harmony-next`).
189+
190+
Claude.ai web can still use the release `harmony-next.skill.zip` upload flow via `Settings > Capabilities > Skills`.
159191

160192
If you only want to attach it as project context:
161193

@@ -166,11 +198,17 @@ claude --add-dir /path/to/harmony-next.skills/harmony-next
166198

167199
### Codex
168200

201+
Recommended Codex install via the `vercel-labs/skills` CLI:
202+
203+
```bash
204+
npx skills add linhay/harmony-next.skills --skill harmony-next -a codex -g -y --copy
205+
```
206+
169207
The official Codex Agent Skills docs define skills as the authoring format for reusable workflows. Direct skill folders are for local authoring and discovery; plugins are the installable distribution unit.
170208

171209
Official docs: <https://developers.openai.com/codex/skills>
172210

173-
This repository is not currently packaged as a Codex plugin, so the official Codex setup path is to place it in an official skill scan location.
211+
This repository is not currently packaged as a Codex plugin. If you do not use `npx skills`, place it in an official skill scan location manually.
174212

175213
Official scan locations:
176214

harmony-next/SKILL.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,10 @@ For "latest", "current", new API, or online-doc parity questions, compare this l
2121

2222
Install/update entrypoints:
2323

24+
- Vercel Labs skills CLI: `npx skills add linhay/harmony-next.skills --skill harmony-next`; add `-a claude-code -g -y --copy` for a non-interactive global Claude Code install, or `-a codex -g -y --copy` for Codex.
2425
- Gemini CLI: `gemini skills install https://github.com/linhay/harmony-next.skills --path harmony-next --scope user`
25-
- Claude.ai / Claude Code: use the release `harmony-next.skill.zip` asset or the `harmony-next/` skill directory.
26-
- Codex: official Agent Skills docs say direct skill folders are for local authoring/discovery. Put or symlink `harmony-next/` into an official Codex scan location such as `$REPO_ROOT/.agents/skills/harmony-next`, `$HOME/.agents/skills/harmony-next`, or `/etc/codex/skills/harmony-next`; for reusable installable distribution, package it as a Codex plugin.
26+
- Claude Code: use `npx skills add linhay/harmony-next.skills --skill harmony-next -a claude-code -g -y --copy`; Claude.ai can still use the release `harmony-next.skill.zip` upload flow.
27+
- Codex: use `npx skills add linhay/harmony-next.skills --skill harmony-next -a codex -g -y --copy`, or put/symlink `harmony-next/` into an official Codex scan location such as `$REPO_ROOT/.agents/skills/harmony-next`, `$HOME/.agents/skills/harmony-next`, or `/etc/codex/skills/harmony-next`; for reusable installable distribution, package it as a Codex plugin.
2728

2829
## Routing
2930

harmony-next/tests/test_skill_metadata.py

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,15 @@ def test_readmes_have_language_switches(self) -> None:
9292
def test_readmes_document_official_codex_skill_locations(self) -> None:
9393
readme_text, readme_en_text = self.require_readmes()
9494
required_readme_fragments = [
95+
"Vercel Labs skills CLI",
96+
"npx skills add linhay/harmony-next.skills --skill harmony-next",
97+
"npx skills add linhay/harmony-next.skills --list",
98+
"npx skills add linhay/harmony-next.skills --skill harmony-next -a claude-code -g -y --copy",
99+
"npx skills add linhay/harmony-next.skills --skill harmony-next -a codex -g -y --copy",
100+
"https://skills.sh/b/linhay/harmony-next.skills",
101+
"https://skills.sh/linhay/harmony-next.skills",
102+
"https://github.com/vercel-labs/agent-skills",
103+
"https://github.com/anthropics/skills",
95104
"官方 Codex Agent Skills 文档",
96105
"https://developers.openai.com/codex/skills",
97106
"$CWD/.agents/skills/harmony-next",
@@ -102,6 +111,15 @@ def test_readmes_document_official_codex_skill_locations(self) -> None:
102111
"可安装分发单元是 Codex plugin",
103112
]
104113
required_readme_en_fragments = [
114+
"Vercel Labs skills CLI",
115+
"npx skills add linhay/harmony-next.skills --skill harmony-next",
116+
"npx skills add linhay/harmony-next.skills --list",
117+
"npx skills add linhay/harmony-next.skills --skill harmony-next -a claude-code -g -y --copy",
118+
"npx skills add linhay/harmony-next.skills --skill harmony-next -a codex -g -y --copy",
119+
"https://skills.sh/b/linhay/harmony-next.skills",
120+
"https://skills.sh/linhay/harmony-next.skills",
121+
"https://github.com/vercel-labs/agent-skills",
122+
"https://github.com/anthropics/skills",
105123
"official Codex Agent Skills docs",
106124
"https://developers.openai.com/codex/skills",
107125
"$CWD/.agents/skills/harmony-next",
@@ -126,6 +144,10 @@ def test_skill_documents_freshness_and_installation_paths(self) -> None:
126144
"GitHub Releases or nightly",
127145
"Huawei online docs",
128146
"Install/update entrypoints:",
147+
"Vercel Labs skills CLI",
148+
"npx skills add linhay/harmony-next.skills --skill harmony-next",
149+
"npx skills add linhay/harmony-next.skills --skill harmony-next -a claude-code -g -y --copy",
150+
"npx skills add linhay/harmony-next.skills --skill harmony-next -a codex -g -y --copy",
129151
"gemini skills install",
130152
"Claude.ai",
131153
"Claude Code",

0 commit comments

Comments
 (0)