# plume-skill

**Repository Path**: wyangvip/plume-skill

## Basic Information

- **Project Name**: plume-skill
- **Description**: 发送plume消息
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-08-31
- **Last Updated**: 2026-09-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Plume Skill

本仓库的唯一 skill 来源是根目录 `SKILL.md`。根目录还包含 OpenCode 所需的
`package.json` 和插件入口 `.opencode/plugins/plume.js`。

## OpenCode：通过 Git 安装

在 OpenCode 的项目级或用户级 `opencode.json` 中加入：

Gitee：

```json
{
  "plugin": [
    "plume-skill@git+https://gitee.com/wyangvip/plume-skill.git#master"
  ]
}
```

GitHub：

```json
{
  "plugin": [
    "plume-skill@git+https://github.com/mythad/plume-skill.git#master"
  ]
}
```

保存配置并重启 OpenCode。使用 OpenCode 原生的 skill 工具验证安装结果：

```text
list skills
load plume
```

如果 Git 安装不可用，可改用本地插件。先克隆仓库，再将配置中的插件值改为仓库的绝对路径：

Gitee：

```bash
git clone https://gitee.com/wyangvip/plume-skill.git /absolute/path/to/plume-skill
```

GitHub：

```bash
git clone https://github.com/mythad/plume-skill.git /absolute/path/to/plume-skill
```

```json
{
  "plugin": ["/absolute/path/to/plume-skill"]
}
```

重启 OpenCode，然后再次使用 OpenCode 原生 skill 工具中的 `list skills` 和 `load plume` 验证。

## Claude Code

先克隆仓库：

Gitee：

```bash
git clone https://gitee.com/wyangvip/plume-skill.git /absolute/path/to/plume-skill
```

GitHub：

```bash
git clone https://github.com/mythad/plume-skill.git /absolute/path/to/plume-skill
```

按 Claude Code 文档配置 project/user skills 搜索路径，并将克隆出的仓库根目录作为 source。客户端应从
根目录的 `SKILL.md` 发现名为 `plume` 的 skill。

如果客户端只接受单个 skill 目录，则建立一个 `plume` 目录，并将根目录的 `SKILL.md` 放入其中：

```bash
mkdir -p /path/to/your/skills/plume
cp /absolute/path/to/plume-skill/SKILL.md /path/to/your/skills/plume/SKILL.md
```

这只是安装时的目录适配，不要维护另一份内容；更新时重新从仓库根目录复制。

## Codex

克隆仓库后，按 Codex 文档配置 project/user skills 搜索路径，并将仓库根目录作为 source；如果客户端
要求单个 skill 目录，则将包含 `SKILL.md` 的 `plume` 目录放入该搜索路径：

Gitee：

```bash
git clone https://gitee.com/wyangvip/plume-skill.git /absolute/path/to/plume-skill
```

GitHub：

```bash
git clone https://github.com/mythad/plume-skill.git /absolute/path/to/plume-skill
```

在 Codex 的 skills 列表或发现机制中确认已经发现 `plume`。不要创建或维护第二份 skill 内容。

## 其他支持 `SKILL.md` 的客户端

按客户端文档配置 skills 搜索路径，并将本仓库根目录作为 source，使其直接发现根目录 `SKILL.md`。如果
客户端只支持单个 skill 目录，可使用上面 `plume` 目录的安装方式，但内容仍以根目录 `SKILL.md` 为准。

## 配置和消息行为

发送消息前设置 `PLUME_URL`，格式为：

```text
PLUME_URL=<server_url>|<api_key>|<recipient_public_key_base64>
```

`server_url` 必须是完整的消息接口地址，例如：

```bash
export PLUME_URL="https://www.plume-message.com/api/messages|sk-xxx|MFkwEwYH..."
```

skill 会按 `|` 拆分并要求恰好三个字段。发送时使用明文内容，不加密：请求中的
`encrypted_content` 是明文，`encrypted` 为 `false`，`encrypted_key` 为空；`to_key` 和
`X-To-Key` 必须是相同的收件人公钥。若未设置 `PLUME_URL`，客户端会向用户询问这三个值。

安全警告：不要在聊天回复、日志、源码或提交内容中暴露 API key。不要把真实密钥写入示例或配置文件。
完整的请求格式、响应码和消息限制以根目录 `SKILL.md` 为准。

## 更新、版本固定和卸载（uninstall）

更新 Git 安装时，将配置中的 ref 更新到需要的分支或 tag，并重启 OpenCode；当前仓库尚无 tag，可使用
`master` 分支。若仍使用旧内容，按客户端
文档清理插件包缓存后再重启。直接克隆的安装则在仓库目录执行 `git pull`，并重新加载或重启客户端。

当前仓库没有可供固定的 tag。创建并发布 tag 后，生产环境应固定实际存在的 tag；不要直接使用下面这类
不存在的版本号示例。当前可用的分支安装示例为：

Gitee：

```json
{
  "plugin": [
    "plume-skill@git+https://gitee.com/wyangvip/plume-skill.git#master"
  ]
}
```

GitHub：

```json
{
  "plugin": [
    "plume-skill@git+https://github.com/mythad/plume-skill.git#master"
  ]
}
```

卸载 OpenCode：从 `opencode.json` 删除 `plume-skill` 插件条目并重启。卸载本地安装：删除该插件条目、
重启客户端，再按需删除克隆目录或 `plume` skill 目录。卸载不会删除或改变 `PLUME_URL`，请另外清理
不再使用的本地密钥配置。