Skip to content

Commit 4c37feb

Browse files
committed
docs: prefer plugin marketplace installation paths
1 parent bf1c123 commit 4c37feb

14 files changed

Lines changed: 172 additions & 1082 deletions

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1818

1919
- **OpenClaw**: Align the plugin entrypoint with `definePluginEntry`, add OpenClaw package metadata, and expose a `frequency` config option.
2020
- **OpenCode**: Use the official `@opencode-ai/plugin` `tool()` helper and prefer globally installed Inner OS protocol/persona files when available.
21-
- **Documentation**: Refresh OpenClaw, OpenCode, Hermes, and global installation docs for plugin packaging and frequency configuration.
21+
- **Documentation**: Refresh installation docs to present platform plugin/marketplace/package installation as the official user path, with script/manual copies limited to development and troubleshooting.
2222

2323
## [0.7.2] - 2026-05-10
2424

README.md

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -89,18 +89,15 @@ Run `/reload-plugins` after installation to activate in the current session —
8989
```bash
9090
# Codex plugin metadata is included at .codex-plugin/plugin.json
9191
# Repo marketplace metadata is included at .agents/plugins/marketplace.json
92-
93-
# Fallback global install for Codex versions without plugin CLI support
94-
node scripts/install.js --platform codex
9592
```
9693
9794
See [codex/README.md](codex/README.md) | [Detailed installation guide](docs/install-codex.md).
9895

9996
### Cursor
10097

10198
```bash
102-
# Install Cursor adapter globally
103-
node scripts/install.js --platform cursor
99+
# Install through Cursor plugin / marketplace
100+
# Plugin metadata is included at .cursor-plugin/plugin.json
104101
```
105102

106103
The repository also includes `.cursor-plugin/plugin.json`, which packages `cursor/` as a Cursor plugin component directory.
@@ -110,37 +107,26 @@ See [cursor/README.md](cursor/README.md) | [Detailed installation guide](docs/in
110107
### OpenCode CLI
111108

112109
```bash
113-
# Copy instruction file
114-
mkdir -p .opencode
115-
cp opencode/inner-os-rules.md .opencode/
116-
117-
# Add instructions to opencode.json
118-
cp opencode/opencode.json ./opencode.json
110+
# Install through OpenCode plugin package
111+
# Add the published package to opencode.json: "plugin": ["ai-inner-os"]
119112
```
120113

121114
See [opencode/README.md](opencode/README.md) | [Detailed installation guide](docs/install-opencode.md).
122115

123116
### Hermes Agent
124117

125118
```bash
126-
# Option 1: Install as Skill (recommended, enables /inner-os command)
127-
cp -r hermes/skills/inner-os ~/.hermes/skills/personality/inner-os
128-
129-
# Option 2: Project-level Context File
130-
cp hermes/hermes.md ./.hermes.md
119+
# Install through Hermes plugin
120+
hermes plugins enable inner-os
131121
```
132122

133123
See [hermes/README.md](hermes/README.md) | [Detailed installation guide](docs/install-hermes.md).
134124

135125
### OpenClaw
136126

137127
```bash
138-
# Option 1: Install as Workspace Skill (recommended, enables /inner-os command)
139-
mkdir -p skills
140-
cp -r openclaw/skills/inner-os skills/inner-os
141-
142-
# Option 2: Global Skill
143-
cp -r openclaw/skills/inner-os ~/.openclaw/skills/inner-os
128+
# Install through OpenClaw plugin / ClawHub
129+
openclaw plugins install clawhub:ai-inner-os
144130
```
145131

146132
See [openclaw/README.md](openclaw/README.md) | [Detailed installation guide](docs/install-openclaw.md).

README_CN.md

Lines changed: 8 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -89,18 +89,15 @@ Inner OS 状态:已启用
8989
```bash
9090
# Codex 插件元数据位于 .codex-plugin/plugin.json
9191
# 仓库级 marketplace 位于 .agents/plugins/marketplace.json
92-
93-
# 若当前 Codex 版本没有 plugin CLI,可使用全局安装脚本
94-
node scripts/install.js --platform codex
9592
```
9693
9794
详见 [codex/README.md](codex/README.md) | [详细安装指南](docs/install-codex.md)
9895

9996
### Cursor
10097

10198
```bash
102-
# 全局安装 Cursor 适配
103-
node scripts/install.js --platform cursor
99+
# 通过 Cursor plugin / marketplace 安装
100+
# 插件元数据位于 .cursor-plugin/plugin.json
104101
```
105102

106103
仓库也包含 `.cursor-plugin/plugin.json`,会将 `cursor/` 目录作为 Cursor 插件组件目录声明。
@@ -110,37 +107,26 @@ node scripts/install.js --platform cursor
110107
### OpenCode CLI
111108

112109
```bash
113-
# 复制指令文件
114-
mkdir -p .opencode
115-
cp opencode/inner-os-rules.md .opencode/
116-
117-
# 在 opencode.json 中添加 instructions
118-
cp opencode/opencode.json ./opencode.json
110+
# 通过 OpenCode plugin package 安装
111+
# 在 opencode.json 中声明已发布插件包:"plugin": ["ai-inner-os"]
119112
```
120113

121114
详见 [opencode/README.md](opencode/README.md) | [详细安装指南](docs/install-opencode.md)
122115

123116
### Hermes Agent
124117

125118
```bash
126-
# 方式一:安装为 Skill(推荐,获得 /inner-os 命令)
127-
cp -r hermes/skills/inner-os ~/.hermes/skills/personality/inner-os
128-
129-
# 方式二:项目级 Context File
130-
cp hermes/hermes.md ./.hermes.md
119+
# 通过 Hermes plugin 安装
120+
hermes plugins enable inner-os
131121
```
132122

133123
详见 [hermes/README.md](hermes/README.md) | [详细安装指南](docs/install-hermes.md)
134124

135125
### OpenClaw
136126

137127
```bash
138-
# 方式一:安装为 Workspace Skill(推荐,获得 /inner-os 命令)
139-
mkdir -p skills
140-
cp -r openclaw/skills/inner-os skills/inner-os
141-
142-
# 方式二:全局 Skill
143-
cp -r openclaw/skills/inner-os ~/.openclaw/skills/inner-os
128+
# 通过 OpenClaw plugin / ClawHub 安装
129+
openclaw plugins install clawhub:ai-inner-os
144130
```
145131

146132
详见 [openclaw/README.md](openclaw/README.md) | [详细安装指南](docs/install-openclaw.md)

codex/README.md

Lines changed: 3 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## 安装
66

7-
### 方式一:Codex 插件清单
7+
正式用户只通过 Codex plugin / marketplace 安装。手动适配、全局脚本、手动复制 `AGENTS.md``hooks.json` 仅用于本仓库开发调试。
88

99
仓库根目录包含正式 Codex 插件清单:
1010

@@ -28,43 +28,6 @@
2828

2929
Codex 可从该 marketplace 发现 `ai-inner-os`,并从当前仓库根目录加载插件组件。
3030

31-
### 方式二:手动适配
32-
33-
#### 1. 复制 AGENTS.md
34-
35-
将 Inner OS 协议注入到你的全局或项目级指令中:
36-
37-
```bash
38-
# 全局生效(所有项目)
39-
cat codex/AGENTS.md >> ~/.codex/AGENTS.md
40-
41-
# 或项目级生效
42-
cat codex/AGENTS.md >> ./AGENTS.md
43-
```
44-
45-
#### 2. 配置 hooks
46-
47-
`codex/hooks.json` 的内容合并到你的 Codex hooks 配置中:
48-
49-
```bash
50-
# 全局
51-
cp codex/hooks.json ~/.codex/hooks.json
52-
53-
# 或项目级
54-
cp codex/hooks.json .codex/hooks.json
55-
```
56-
57-
> 注意:插件安装时从插件根目录解析 `./codex/hooks/*.js`;手动复制到 `~/.codex/hooks.json` 时,建议改成绝对路径,或使用 `node scripts/install.js --platform codex` 自动生成。
58-
59-
#### 3. 确认 hooks 功能已启用
60-
61-
`~/.codex/config.toml` 或项目级 `.codex/config.toml` 中确认:
62-
63-
```toml
64-
[features]
65-
codex_hooks = true
66-
```
67-
6831
## Hook 生命周期
6932

7033
| Hook | 触发时机 | 作用 |
@@ -75,16 +38,7 @@ codex_hooks = true
7538

7639
## Persona(人设切换)
7740

78-
Codex CLI 支持读取 Inner OS 人设配置。手动编辑 `personas/_active.json` 来切换:
79-
80-
```json
81-
{
82-
"persona": "tsundere",
83-
"updatedAt": "2026-04-13T10:00:00.000Z"
84-
}
85-
```
86-
87-
可选值:`default``tsundere``cold``cheerful``philosopher``sarcastic`,或 `personas/custom/` 下自定义文件名。
41+
正式安装场景下,人设与频率应由插件配置或插件命令管理。仓库内 `scripts/switch-persona.js` 只用于维护静态适配副本。
8842

8943
## 与 Claude Code 版本的差异
9044

@@ -93,4 +47,4 @@ Codex CLI 支持读取 Inner OS 人设配置。手动编辑 `personas/_active.js
9347
| 协议注入 | SessionStart hook 自动读取 SKILL.md | AGENTS.md 静态加载 |
9448
| 失败追踪 | PostToolUseFailure 独立 hook | 无(Codex 暂不支持) |
9549
| Hook 数量 | 9 个 | 3 个 |
96-
| 安装方式 | 插件市场一键安装 | Codex 插件清单 / 全局安装脚本 / 手动复制配置 |
50+
| 安装方式 | 插件市场一键安装 | Codex plugin / marketplace |

cursor/README.md

Lines changed: 4 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
## 安装
1818

19-
### 方式一:Cursor 插件清单
19+
正式用户只通过 Cursor plugin / marketplace 安装。全局脚本和手动复制 `.mdc` / `hooks.json` 仅用于本仓库开发调试,不作为正式安装或更新路径。
2020

2121
仓库根目录包含 `.cursor-plugin/plugin.json`,清单直接引用 `cursor/` 下的规则和 hooks:
2222

@@ -27,26 +27,7 @@
2727
}
2828
```
2929

30-
用于 Cursor 插件分发或本地插件加载时,不需要再把 `cursor/` 拆成单独目录。
31-
32-
### 方式二:全局安装脚本
33-
34-
如果只想在当前机器全局启用:
35-
36-
```bash
37-
node scripts/install.js --platform cursor
38-
```
39-
40-
脚本会把运行时文件复制到 `~/.inner-os/`,并将 hooks 合并写入 `~/.cursor/hooks.json`,不会覆盖已有 hook 配置。
41-
42-
### 方式三:仅使用项目规则
43-
44-
如果只需要静态协议注入,可以把规则复制到目标项目:
45-
46-
```bash
47-
mkdir -p .cursor/rules
48-
cp cursor/rules/inner-os-protocol.mdc .cursor/rules/
49-
```
30+
用于 Cursor 插件分发或本地插件加载时,不需要再把 `cursor/` 拆成单独目录。发布更新时 bump `.cursor-plugin/plugin.json``.cursor-plugin/marketplace.json` 的版本号。
5031

5132
## 工作原理
5233

@@ -59,15 +40,7 @@ Cursor 的 `preToolUse` 不支持注入 `additional_context`,所以没有使
5940

6041
## Persona(人设切换)
6142

62-
通过全局安装脚本启用 hooks 后,Cursor 会在 `sessionStart` 读取 `~/.inner-os/personas/_active.json` 和对应人设文件。切换方式:
63-
64-
```bash
65-
node ~/.inner-os/scripts/switch-persona.js --list
66-
node ~/.inner-os/scripts/switch-persona.js sarcastic
67-
node ~/.inner-os/scripts/switch-persona.js default
68-
```
69-
70-
如果只复制 `.mdc` 规则而不启用 hooks,则需要把 `personas/<name>.md` 的正文手动追加到 `cursor/rules/inner-os-protocol.mdc` 的 persona 标记区。
43+
正式安装场景下,人设与频率应由插件配置或插件命令管理。仓库内 `scripts/switch-persona.js` 只用于维护静态适配副本。
7144

7245
## 与其他平台的差异
7346

@@ -76,4 +49,4 @@ node ~/.inner-os/scripts/switch-persona.js default
7649
| 协议注入 | SessionStart hook 读取 SKILL.md | SessionStart hook / AGENTS.md | `.mdc` 规则 + `sessionStart` hook |
7750
| Hook 数量 | 9 个 | 3 个 | 3 个 |
7851
| 失败追踪 | PostToolUseFailure | 不支持 | 不支持 |
79-
| 安装方式 | 插件市场一键安装 | `install.js` 全局安装 | Cursor 插件清单 / `install.js` 全局安装 |
52+
| 安装方式 | 插件市场一键安装 | Codex plugin / marketplace | Cursor plugin / marketplace |

0 commit comments

Comments
 (0)