Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions PRD-v3.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,15 @@
- [ ] **真 Windows host 上 smoke test 0.4.5**(`npx petsonality@latest` + `/pet`)
- [ ] **测 `claude plugin install github:nanami-he/petsonality`**(需要新装 Claude Code 测)
- [ ] 提交 petsonality 到 [MCP Server Registry](https://modelcontextprotocol.io) 的 server directory
- [ ] README 加「Install」章节,列出 3 条路径(npx 主推,plugin 次推,git clone 给开发者)
- [ ] **dist/reactions-pool.json 改为确定性输出**(当前每次 build 都 reorder ~700 行,commit noise;改为对 array 排序后再 stringify)
- [x] README 加「Install」章节,列出 3 条路径(npx 主推,plugin 次推,git clone 给开发者)
- [x] **dist/reactions-pool.json 改为确定性输出**(当前每次 build 都 reorder ~700 行,commit noise;改为对 array 排序后再 stringify)
- [ ] (长期)写 Homebrew formula

**优先级理由**:npm outage 已经发生过一次,下次会再发生。在更多用户进来前把 multi-channel 架构跑通,等 0.4.5 / 0.5.0 时已经稳了。

**进度(2026-04-29)**:核心架构 4/4 done(v0.4.5 已 ship),剩下都是验证 + 推广 + 优化。multi-channel 已经从「想法」变成「真有这条路径」。
**进度(2026-04-29)**:核心架构 4/4 done(v0.4.5 已 ship),multi-channel 已经从「想法」变成「真有这条路径」。

**进度(2026-05-01)**:README Install 章节补齐三条路径;`dist/reactions-pool.json` 输出改为确定性排序,减少每次 build 的 generated diff 噪音。剩余 G0 主要是 registry 提交、真实 plugin install smoke test、Windows host smoke test、长期 Homebrew。

### G1: 社区推广
- [x] Twitter/X 发帖(v0.4.0 launch tweet, 2026-04-18,reach 小但已发)
Expand Down
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,20 +56,33 @@ Every animal speaks differently. The Fox asks "Are you sure?" with a smirk. The

</details>

## Quick Start
## Install

Works with [Claude Code](https://claude.ai/code) and [OpenClaw](https://github.com/openclaw/openclaw).

> **Terminal CLI only.** The pet renders in the terminal status line, which is a CLI feature. The Claude Code desktop app and web client (claude.ai/code) don't expose a status line, so the animated pet won't appear there. MCP tool output (e.g. `/pet show`) still works in any client.
>
> **Windows note.** Claude Code for Windows has an upstream status-line trust regression in some versions. If the status line is configured but does not render, accept the project trust dialog or ensure the project is marked trusted in `~/.claude.json`, then restart Claude Code.

### npm / npx

```bash
# Install
npx petsonality
```

Or build from source (requires [bun](https://bun.sh)):
This is the recommended path for most users. It installs the MCP server, `/pet` skill, hooks, and status line assets, then stores runtime files in `~/.petsonality/`.

### Claude Code plugin

```bash
claude plugin install github:nanami-he/petsonality
```

Use this if you prefer Claude Code's plugin install flow. The plugin runs the built Node.js server from `dist/`, so it does not require Bun.

### From source

Use this path if you want to develop Petsonality locally or inspect the code before installing. Requires [Bun](https://bun.sh).

```bash
git clone https://github.com/nanami-he/petsonality.git
Expand Down
Loading
Loading