@yottameta/yotta-humanize 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +29 -41
  3. package/README.zh-CN.md +29 -41
  4. package/SKILL.md +1 -1
  5. package/package.json +1 -1
  6. package/scripts/yotta_humanize.py +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # 更新日志
2
2
 
3
+ ## v0.1.2 (2026-08-29)
4
+
5
+ - 安装方式统一为四方式（对齐发布规范 §3.3.1）：方式一 `npx -y @yottameta/yotta-humanize --agent <name>` / `--dir <dir>`（推荐，走 npm 源）；方式二 `git clone https://github.com/YottaMeta/yotta-humanize.git`；方式三 GitHub Download ZIP；方式四 `bash install.sh --agent/--dir/--list`。移除 `npx skills` 与 `-g` 推荐；中英双 README 安装节同步。
6
+ - 版本对齐：package.json / SKILL.md / CHANGELOG / 引擎 VERSION / 测试断言 / README 锚点 = 0.1.2。
7
+ - 无功能变更（仅文档与版本同步）。
8
+
3
9
  ## v0.1.1 (2026-08-28)
4
10
 
5
11
  中英双语 README 对齐（老张拍板「英文门面 + 中文全档」）：
package/README.md CHANGED
@@ -42,7 +42,7 @@ It is not tied to any single platform: an agent-agnostic toolkit that works in a
42
42
  | **Chinese-first** | Wordlists and patterns for Chinese AI-flavor (jargon / clichés / parallelism / chat residue) curated from scratch, not translated English rules |
43
43
  | **Detect + rewrite in one** | score / analyze / report / suggest / rewrite — one command from detection to rewriting |
44
44
  | **Reviewable** | Rewrites output a fix list and before/after scores so humans can verify item by item |
45
- | **Ecosystem distribution** | GitHub + npm + ClawHub synced; install via npx / install.sh / manual copy |
45
+ | **Ecosystem distribution** | GitHub + npm + ClawHub synced; four install methods (npx / git clone / Download ZIP / install.sh) |
46
46
 
47
47
  ## Commands
48
48
 
@@ -86,51 +86,39 @@ Exit codes (same semantics as the YuanAn / YuanShen / Yuandun family): **0** = s
86
86
 
87
87
  ## Install
88
88
 
89
- Pick any one of the three methods; skill files are fetched from **npm** (GitHub is slower without a proxy; npm can use a domestic mirror).
89
+ Pick any of the four methods below; the order is the recommended priority. Skill files always come from **npm** (GitHub can be slow without a proxy; npm supports mirrors).
90
90
 
91
- ### Method 1: npm (recommended, one-liner)
92
- ```bash
93
- # domestic mirror (optional): npm config set registry https://registry.npmmirror.com
94
- npx -y @yottameta/yotta-humanize -g
95
- npx -y @yottameta/yotta-humanize --dir <your-skills-dir> # any agent: install to a specific directory
91
+ ### Method 1: npm one-liner (recommended)
92
+
93
+ ```text
94
+ # Optional China mirror: npm config set registry https://registry.npmmirror.com
95
+ npx -y @yottameta/yotta-humanize --agent <agent-name> # install to the agent's default user-level skills dir
96
+ npx -y @yottameta/yotta-humanize --dir <your-skills-dir> # point to the skills dir itself (e.g. ~/.codex/skills)
96
97
  ```
97
- > Not in the preset list? Use --dir to point at the agent's skills directory, or manual copy (method 3). --list shows each agent's default directory. You can also npm pack @yottameta/yotta-humanize and unpack it to install via method 2 / 3.
98
98
 
99
- ### Method 2: install.sh one-shot
100
- After obtaining the skill folder (npm pack unpack or git clone), enter the folder:
101
- ```bash
102
- bash install.sh -g # user level; bash install.sh --list shows all directories
103
- bash install.sh --agent codex # specific agent (--list shows available ones)
104
- bash install.sh # project level: auto-detect existing .claude/.cursor/.codex skills dirs
105
- bash install.sh --dir /path/to/skills
99
+ - `--agent <name>` installs to that agent's default user-level directory; `--list` shows each agent's default directory.
100
+ - `--dir <path>` installs to the given directory; for agents not in the preset list, point `--dir` at their skills directory.
101
+ - If the mirror has not synced the new package (404): add `--registry=https://registry.npmjs.org/` (a proxy may be needed in China), or wait for the mirror cache.
102
+
103
+ ### Method 2: git clone (developers / git available)
104
+
105
+ ```text
106
+ git clone https://github.com/YottaMeta/yotta-humanize.git <your-skills-dir>/yotta-humanize
107
+ ```
108
+
109
+ ### Method 3: GitHub Download ZIP (manual / no git)
110
+
111
+ On the GitHub repository `YottaMeta/yotta-humanize`, click **Code → Download ZIP**, unzip it and put the `yotta-humanize` folder into the agent's skills directory.
112
+
113
+ ### Method 4: install.sh (multi-agent one-liner script)
114
+
115
+ ```text
116
+ bash install.sh --agent <name> # install to the agent's default user-level directory
117
+ bash install.sh --dir <path> # install to the given directory
118
+ bash install.sh --list # list agents -> default directories
106
119
  ```
107
- > Covers 17 agent families including Trae / Qwen / Comate / CodeBuddy / Kimi. Windows users: works with Git Bash; otherwise use method 3.
108
-
109
- ### Method 3: manual copy
110
- Copy the whole yotta-humanize folder into the target agent's skills directory. Common locations (user level; Windows uses %USERPROFILE%, Linux/macOS uses ~):
111
-
112
- | Agent | User-level directory | Project-level directory |
113
- |---|---|---|
114
- | Codex | %USERPROFILE%\.codex\skills\yotta-humanize\ | .codex\skills\ |
115
- | Claude Code | %USERPROFILE%\.claude\skills\yotta-humanize\ | .claude\skills\ |
116
- | Cursor | %USERPROFILE%\.cursor\skills\yotta-humanize\ | .cursor\skills\ |
117
- | Windsurf | %USERPROFILE%\.codeium\windsurf\skills\yotta-humanize\ | .windsurf\skills\ |
118
- | opencode | %USERPROFILE%\.config\opencode\skills\yotta-humanize\ | .opencode\skills\ |
119
- | Gemini | %USERPROFILE%\.gemini\skills\yotta-humanize\ | .gemini\skills\ |
120
- | Goose | %USERPROFILE%\.config\goose\skills\yotta-humanize\ | .goose\skills\ |
121
- | Amp | %USERPROFILE%\.config\agents\skills\yotta-humanize\ | .agents\skills\ |
122
- | Kiro | %USERPROFILE%\.kiro\skills\yotta-humanize\ | .kiro\skills\ |
123
- | WorkBuddy | %USERPROFILE%\.workbuddy\skills\yotta-humanize\ | .workbuddy\skills\ |
124
- | Trae Code CLI | %USERPROFILE%\.traecli\skills\yotta-humanize\ | .traecli\skills\ |
125
- | Trae IDE (CN) | %USERPROFILE%\.trae-cn\skills\yotta-humanize\ | .trae\skills\ |
126
- | Qwen Code | %USERPROFILE%\.qwen\skills\yotta-humanize\ | .qwen\skills\ |
127
- | Comate | %USERPROFILE%\.comate\skills\yotta-humanize\ | .comate\skills\ |
128
- | CodeBuddy | %USERPROFILE%\.codebuddy\skills\yotta-humanize\ | .codebuddy\skills\ |
129
- | Kimi | %USERPROFILE%\.kimi\skills\yotta-humanize\ | .kimi\skills\ |
130
- | Generic AGENTS.md | %USERPROFILE%\.agents\skills\yotta-humanize\ | .agents\skills\ |
131
-
132
- > If Codex's CODEX_HOME is set, it overrides the default; the same applies to opencode's XDG_CONFIG_HOME. .agents\skills is not a universal directory — only OpenCode / Cursor / Cline / Amp / Kimi / Gemini CLI / GitHub Copilot etc. read it; **Claude Code and Codex do not read it by default**. When unsure, use --dir or let the agent install it.
133
120
 
121
+ > Method 1 uses the npm registry (npmmirror / npmjs) and does not depend on GitHub; Methods 2/3 use GitHub and may fail without a proxy in China.
134
122
  ## Usage examples (AI agent)
135
123
 
136
124
  1. Hook this repo's SKILL.md into any AI agent's skill/rule system (see install above).
package/README.zh-CN.md CHANGED
@@ -43,7 +43,7 @@ AI 生成的中文文本有一眼可辨的「AI 腔」：空泛升华（标志
43
43
  | **中文优先** | 针对中文 AI 腔（黑话 / 套话 / 排比 / 聊天残渣）自研词表与句式，非英文规则直译 |
44
44
  | **检测 + 改写一体** | score / analyze / report / suggest / rewrite 全流程，一条命令从检测到改写 |
45
45
  | **可复核** | 改写输出修复清单与前后评分，人工可逐条核对 |
46
- | **生态分发** | GitHub + npm + ClawHub 三源同步发布；npx / install.sh / 手动复制三种安装方式 |
46
+ | **生态分发** | GitHub + npm + ClawHub 三源同步发布；npx / git clone / Download ZIP / install.sh 四种安装方式 |
47
47
 
48
48
  ## 功能体系
49
49
 
@@ -87,51 +87,39 @@ python3 scripts/yotta_humanize.py score -f article.md --gate --threshold 45
87
87
 
88
88
  ## 安装
89
89
 
90
- 三种方式任选其一，技能文件统一从 **npm** 获取（GitHub 无代理时较慢，npm 可配国内镜像加速）。
90
+ 以下四种方式任选，顺序即推荐优先级；技能文件一律从 **npm** 获取（GitHub 无代理较慢，npm 支持镜像）。
91
91
 
92
- ### 方式一：npm（推荐，一行安装）
93
- ```bash
94
- # 国内加速（可选）：npm config set registry https://registry.npmmirror.com
95
- npx -y @yottameta/yotta-humanize -g
96
- npx -y @yottameta/yotta-humanize --dir <你的技能目录> # 任意智能体：指定目录安装
92
+ ### 方式一：npm 一行装（推荐）
93
+
94
+ ```text
95
+ # 可选国内加速：npm config set registry https://registry.npmmirror.com
96
+ npx -y @yottameta/yotta-humanize --agent <智能体名称> # 装到指定智能体默认用户级技能目录
97
+ npx -y @yottameta/yotta-humanize --dir <智能体的技能目录> # 指到技能目录本身（如 ~/.codex/skills）
97
98
  ```
98
- > 智能体不在预置列表里？用 --dir 指定它的 skills 目录，或手动复制（方式三）。--list 可查看各智能体对应的默认目录。想手动拿文件也可 npm pack @yottameta/yotta-humanize 解包后按方式二/三安装。
99
99
 
100
- ### 方式二：install.sh 一键安装
101
- 获取技能文件夹后（npm pack 解包或 git clone），进入技能文件夹：
102
- ```bash
103
- bash install.sh -g # 用户级；bash install.sh --list 查看全部目录
104
- bash install.sh --agent codex # 指定智能体（--list 可查看可用项）
105
- bash install.sh # 项目级：自动检测已存在的 .claude/.cursor/.codex 等 skills 目录
106
- bash install.sh --dir /path/to/skills
100
+ - `--agent <name>` 自动装到该智能体默认用户级目录；`--list` 可查看各智能体默认目录。
101
+ - `--dir <路径>` 装到指定的技能目录；未收录的智能体用 `--dir` 指到它的技能目录。
102
+ - npmmirror 未同步新包（404）：加 `--registry=https://registry.npmjs.org/`（国内需代理），或稍等镜像缓存。
103
+
104
+ ### 方式二：git clone（开发者 / 有 git 环境）
105
+
106
+ ```text
107
+ git clone https://github.com/YottaMeta/yotta-humanize.git <智能体的技能目录>/yotta-humanize
108
+ ```
109
+
110
+ ### 方式三：GitHub 下载压缩包（手动 / 无 git 环境）
111
+
112
+ 在 GitHub 仓库 `YottaMeta/yotta-humanize` 点 **Code → Download ZIP**，解压后把 `yotta-humanize` 文件夹放进智能体技能目录。
113
+
114
+ ### 方式四：install.sh（多智能体一键脚本）
115
+
116
+ ```text
117
+ bash install.sh --agent <name> # 装到指定智能体默认用户级目录
118
+ bash install.sh --dir <path> # 装到指定目录
119
+ bash install.sh --list # 列出智能体 -> 默认目录
107
120
  ```
108
- > 覆盖 17 类智能体，含国内 Trae / Qwen / Comate / CodeBuddy / Kimi。Windows 用户：装有 Git Bash 即可用；否则用方式三手动复制。
109
-
110
- ### 方式三：手动复制
111
- 把整个 yotta-humanize 文件夹复制到目标智能体的 skills 目录。常见位置（用户级；Windows 用 %USERPROFILE%，Linux/macOS 用 ~）：
112
-
113
- | 智能体 | 用户级目录 | 项目级目录 |
114
- |---|---|---|
115
- | Codex | %USERPROFILE%\.codex\skills\yotta-humanize\ | .codex\skills\ |
116
- | Claude Code | %USERPROFILE%\.claude\skills\yotta-humanize\ | .claude\skills\ |
117
- | Cursor | %USERPROFILE%\.cursor\skills\yotta-humanize\ | .cursor\skills\ |
118
- | Windsurf | %USERPROFILE%\.codeium\windsurf\skills\yotta-humanize\ | .windsurf\skills\ |
119
- | opencode | %USERPROFILE%\.config\opencode\skills\yotta-humanize\ | .opencode\skills\ |
120
- | Gemini | %USERPROFILE%\.gemini\skills\yotta-humanize\ | .gemini\skills\ |
121
- | Goose | %USERPROFILE%\.config\goose\skills\yotta-humanize\ | .goose\skills\ |
122
- | Amp | %USERPROFILE%\.config\agents\skills\yotta-humanize\ | .agents\skills\ |
123
- | Kiro | %USERPROFILE%\.kiro\skills\yotta-humanize\ | .kiro\skills\ |
124
- | WorkBuddy | %USERPROFILE%\.workbuddy\skills\yotta-humanize\ | .workbuddy\skills\ |
125
- | Trae Code CLI | %USERPROFILE%\.traecli\skills\yotta-humanize\ | .traecli\skills\ |
126
- | Trae IDE（国内） | %USERPROFILE%\.trae-cn\skills\yotta-humanize\ | .trae\skills\ |
127
- | Qwen Code | %USERPROFILE%\.qwen\skills\yotta-humanize\ | .qwen\skills\ |
128
- | Comate | %USERPROFILE%\.comate\skills\yotta-humanize\ | .comate\skills\ |
129
- | CodeBuddy | %USERPROFILE%\.codebuddy\skills\yotta-humanize\ | .codebuddy\skills\ |
130
- | Kimi | %USERPROFILE%\.kimi\skills\yotta-humanize\ | .kimi\skills\ |
131
- | 通用 AGENTS.md | %USERPROFILE%\.agents\skills\yotta-humanize\ | .agents\skills\ |
132
-
133
- > Codex 默认目录若设置了环境变量 CODEX_HOME，以该变量为准；opencode 若设置 XDG_CONFIG_HOME 同理。.agents\skills 并非通用目录，仅 OpenCode / Cursor / Cline / Amp / Kimi / Gemini CLI / GitHub Copilot 等会读取，Claude Code 与 Codex 默认不读。不确定时用 --dir 指定，或让该智能体自行安装。
134
121
 
122
+ > 方式一走 npm 源（npmmirror / npmjs），不依赖 GitHub；方式二 / 三走 GitHub，国内无代理可能失败。
135
123
  ## 使用示例（AI 智能体）
136
124
 
137
125
  1. 将本仓库的 SKILL.md 接入任意 AI 智能体的技能/规则系统（见上方安装）。
package/SKILL.md CHANGED
@@ -1,6 +1,6 @@
1
1
  ---
2
2
  name: yotta-humanize
3
- version: 0.1.1
3
+ version: 0.1.2
4
4
  description: 元真 —— 去 AI 味的中文写作编辑技能：检测器引擎（24 类规则 + 词表 + 统计突发性）识别并改写 AI 腔文本，让中文写作更自然、更像人写的。触发：编辑 / 润色文本、去 AI 味、让文章 / 文案 / 回复更像人写、发现文本充斥着 AI 常用词与句式（赋能 / 闭环 / 值得注意的是 / 综上所述 / 希望对你有所帮助 等）、给 AI 生成的中文稿件做检测与改写。边界：只处理文本，不生成新内容；不改写事实 / 数据 / 专有名词；不破坏作者原意；改写为确定性规则，不依赖模型。
5
5
  license: MIT
6
6
  ---
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yottameta/yotta-humanize",
3
- "version": "0.1.1",
3
+ "version": "0.1.2",
4
4
  "description": "Yuanzhen (元真) — AI-flavor remover for Chinese writing: a detector engine (24 rule classes + wordlists + statistical burstiness) that identifies and rewrites AI-typical Chinese text to make it read more naturally. Triggers when editing/polishing text, removing AI flavor, or making copy read more human. Boundaries: text-only, deterministic rewrites, no model dependency.",
5
5
  "license": "MIT",
6
6
  "keywords": [
package/scripts/yotta_humanize.py CHANGED
@@ -47,7 +47,7 @@ _HERE = Path(__file__).resolve().parent
47
47
  sys.path.insert(0, str(_HERE))
48
48
  import humanize_rules as HR # noqa: E402
49
49
 
50
- VERSION = "0.1.1"
50
+ VERSION = "0.1.2"
51
51
  TOOL_NAME = "yotta-humanize"
52
52
  TOOL_CN = "元真"
53
53
  DEFAULT_THRESHOLD = 45