Skip to content

Commit d03d3dd

Browse files
authored
docs: verify public install and refresh launch metrics (#1)
Co-authored-by: JNHFlow21 <JNHFlow21@users.noreply.github.com>
1 parent 5810aa8 commit d03d3dd

3 files changed

Lines changed: 32 additions & 23 deletions

File tree

.github/repository-metrics-traffic.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"views_14d": 0,
44
"unique_cloners_14d": 0,
55
"clones_14d": 0,
6-
"traffic_as_of": "2026-08-11T00:00:00Z",
6+
"traffic_as_of": "2026-08-11T14:09:50Z",
77
"clone_series_14d": [
88
{
99
"timestamp": "2026-07-29T00:00:00Z",

README.md

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,24 +39,28 @@ merge, change visibility, or place credentials in documentation.
3939

4040
## Quick start
4141

42-
### 1. Install with Codex's built-in Skill Installer
42+
### 1. Install project-locally
4343

44-
Ask Codex:
44+
```bash
45+
DISABLE_TELEMETRY=1 npx skills add JNHFlow21/open-source-launch \
46+
--skill open-source-launch \
47+
--agent codex \
48+
--yes
49+
```
50+
51+
This verified route installs the Skill into the current project's
52+
`.agents/skills/open-source-launch/` directory. `DISABLE_TELEMETRY=1` opts out
53+
of the installer CLI's anonymous telemetry; Open Source Launch itself has no
54+
telemetry.
55+
56+
Alternatively, ask Codex's built-in Skill Installer:
4557

4658
```text
4759
Use $skill-installer to install open-source-launch from
4860
https://github.com/JNHFlow21/open-source-launch/tree/main/skills/open-source-launch
4961
```
5062

51-
Or run the same installer helper directly:
52-
53-
```bash
54-
python3 "${CODEX_HOME:-$HOME/.codex}/skills/.system/skill-installer/scripts/install-skill-from-github.py" \
55-
--repo JNHFlow21/open-source-launch \
56-
--path skills/open-source-launch
57-
```
58-
59-
Start a new Codex turn after installation so the Skill can be discovered.
63+
Start a new Codex turn after either route so the Skill can be discovered.
6064

6165
### 2. Run a read-only launch audit
6266

@@ -180,6 +184,7 @@ the public README URL never contains a long-lived token.
180184
## Requirements and boundaries
181185

182186
- Designed and verified for Codex Skills; other `SKILL.md`-compatible agents may work but are not part of the verified support claim.
187+
- Node.js with `npx` is required only for the canonical project-local install route; the Skill runtime does not depend on Node.js.
183188
- Python 3.10+ is required only for the deterministic helper scripts.
184189
- `git` is required for tracked-file and working-tree evidence.
185190
- `gh`, authenticated owner access, and Gitleaks are optional and used only for the corresponding GitHub/secret-history gates.

README.zh-CN.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,24 +37,27 @@ Open Source Launch 为 Codex 提供一套可重复执行的发布契约:
3737

3838
## 快速开始
3939

40-
### 1. 使用 Codex 内置 Skill Installer 安装
40+
### 1. 安装到当前项目
4141

42-
对 Codex 说:
42+
```bash
43+
DISABLE_TELEMETRY=1 npx skills add JNHFlow21/open-source-launch \
44+
--skill open-source-launch \
45+
--agent codex \
46+
--yes
47+
```
48+
49+
这条已验证路径会把 Skill 安装到当前项目的
50+
`.agents/skills/open-source-launch/``DISABLE_TELEMETRY=1` 用于关闭安装器 CLI
51+
的匿名遥测;Open Source Launch 本身不包含遥测。
52+
53+
也可以让 Codex 内置 Skill Installer 完成安装:
4354

4455
```text
4556
Use $skill-installer to install open-source-launch from
4657
https://github.com/JNHFlow21/open-source-launch/tree/main/skills/open-source-launch
4758
```
4859

49-
也可以直接调用同一个安装器:
50-
51-
```bash
52-
python3 "${CODEX_HOME:-$HOME/.codex}/skills/.system/skill-installer/scripts/install-skill-from-github.py" \
53-
--repo JNHFlow21/open-source-launch \
54-
--path skills/open-source-launch
55-
```
56-
57-
安装后开启一个新的 Codex 轮次,让系统重新发现 Skill。
60+
通过任一路径安装后,都要开启一个新的 Codex 轮次,让系统重新发现 Skill。
5861

5962
### 2. 执行只读发布审计
6063

@@ -171,6 +174,7 @@ python3 skills/open-source-launch/scripts/install_repository_pulse.py \
171174
## 要求与边界
172175

173176
- 为 Codex Skills 设计并验证;其他兼容 `SKILL.md` 的 Agent 可能可用,但不属于已验证支持声明。
177+
- 只有项目级标准安装路径需要带 `npx` 的 Node.js;Skill 运行时不依赖 Node.js。
174178
- 只有确定性辅助脚本需要 Python 3.10+。
175179
- 需要 `git` 才能提供被跟踪文件和工作区状态证据。
176180
- `gh`、仓库 Owner 权限和 Gitleaks 都是可选项,仅用于对应的 GitHub 或历史密钥门禁。

0 commit comments

Comments
 (0)