Skip to content

Commit 1de8de6

Browse files
committed
Release OpenPet v0.1.4
1 parent 6308596 commit 1de8de6

19 files changed

Lines changed: 139 additions & 86 deletions

File tree

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ src-tauri/target/
77
.workflow/
88
AGENTS.md
99
.playwright-mcp/
10-
codex-pet-runtime-settings-ui*.png
10+
openpet-settings-ui*.png
1111
*.log
1212
.env
1313
.env.*

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -61,30 +61,30 @@ The importer downloads public metadata and the WebP spritesheet for the URL you
6161

6262
OpenPet is designed to be controlled by local agents. Install only the skills you need:
6363

64-
- `codex-pet-cli`: CLI control path for agents that can run local commands.
65-
- `codex-pet-mcp`: MCP control path for agents or clients that support Model Context Protocol.
66-
- `codex-pet-asset`: optional pet creation / validation workflow; install only when creating or packaging pets.
64+
- `openpet-cli`: CLI control path for agents that can run local commands.
65+
- `openpet-mcp`: MCP control path for agents or clients that support Model Context Protocol.
66+
- `openpet-asset`: optional pet creation / validation workflow; install only when creating or packaging pets.
6767

68-
For normal control, choose either `codex-pet-cli` or `codex-pet-mcp`. Agents that can call localhost directly can use the HTTP API guidance below without installing a separate skill.
68+
For normal control, choose either `openpet-cli` or `openpet-mcp`. Agents that can call localhost directly can use the HTTP API guidance below without installing a separate skill.
6969

7070
### Agent Hook Tip
7171

72-
If you want OpenPet to collaborate with an existing agent, add a short note to `AGENTS.md`, `.cursorrules`, or a similar agent instruction file. Tell the agent to use an installed OpenPet skill, such as `codex-pet-cli` or `codex-pet-mcp`, for desktop-pet progress updates during long work.
72+
If you want OpenPet to collaborate with an existing agent, add a short note to `AGENTS.md`, `.cursorrules`, or a similar agent instruction file. Tell the agent to use an installed OpenPet skill, such as `openpet-cli` or `openpet-mcp`, for desktop-pet progress updates during long work.
7373

7474
If several OpenPet skills are installed, let the agent choose one integration path and condense the chosen rule into its local instruction file. The rule should reference the installed skill instead of duplicating protocol or command details.
7575

7676
### CLI
7777

7878
```powershell
79-
python skills\codex-pet-cli\scripts\codex_pet_cli.py --help
80-
python skills\codex-pet-cli\scripts\codex_pet_cli.py doctor --json
81-
python skills\codex-pet-cli\scripts\codex_pet_cli.py status --json
82-
python skills\codex-pet-cli\scripts\codex_pet_cli.py event thinking --message "Reading the repo..."
83-
python skills\codex-pet-cli\scripts\codex_pet_cli.py import-local public\pets\nia --dry-run --json
84-
python skills\codex-pet-cli\scripts\codex_pet_cli.py import-website https://petdex.crafter.run/pets/boba
79+
python skills\openpet-cli\scripts\openpet_cli.py --help
80+
python skills\openpet-cli\scripts\openpet_cli.py doctor --json
81+
python skills\openpet-cli\scripts\openpet_cli.py status --json
82+
python skills\openpet-cli\scripts\openpet_cli.py event thinking --message "Reading the repo..."
83+
python skills\openpet-cli\scripts\openpet_cli.py import-local public\pets\nia --dry-run --json
84+
python skills\openpet-cli\scripts\openpet_cli.py import-website https://petdex.crafter.run/pets/boba
8585
```
8686

87-
In agent instructions, tell the agent to use the `codex-pet-cli` skill for status checks, progress events, or pet imports. The CLI calls the running local runtime; if OpenPet is not reachable, live commands fail safely with a clear message instead of modifying app data behind the app's back.
87+
In agent instructions, tell the agent to use the `openpet-cli` skill for status checks, progress events, or pet imports. The CLI calls the running local runtime; if OpenPet is not reachable, live commands fail safely with a clear message instead of modifying app data behind the app's back.
8888

8989
### MCP
9090

@@ -95,7 +95,7 @@ The MCP bridge is for IDEs or agents that support Model Context Protocol. Open y
9595
"mcpServers": {
9696
"openpet": {
9797
"command": "python",
98-
"args": ["skills/codex-pet-mcp/scripts/openpet_mcp_server.py"]
98+
"args": ["skills/openpet-mcp/scripts/openpet_mcp_server.py"]
9999
}
100100
}
101101
}
@@ -146,10 +146,10 @@ You can change the runtime listen address and port in Settings. Endpoint changes
146146
```powershell
147147
pnpm build
148148
cargo test --manifest-path src-tauri/Cargo.toml
149-
python skills\codex-pet-cli\scripts\codex_pet_cli.py --help
150-
python skills\codex-pet-mcp\scripts\openpet_mcp_server.py --help
151-
python skills\codex-pet-cli\scripts\codex_pet_cli.py doctor --json
152-
python skills\codex-pet-cli\scripts\codex_pet_cli.py import-local public\pets\nia --dry-run --json
149+
python skills\openpet-cli\scripts\openpet_cli.py --help
150+
python skills\openpet-mcp\scripts\openpet_mcp_server.py --help
151+
python skills\openpet-cli\scripts\openpet_cli.py doctor --json
152+
python skills\openpet-cli\scripts\openpet_cli.py import-local public\pets\nia --dry-run --json
153153
```
154154

155155
For release checks and bundles:

README.zh-CN.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -61,30 +61,30 @@ spritesheet.webp
6161

6262
OpenPet 面向本地 agent 控制。按需要安装对应 skill:
6363

64-
- `codex-pet-cli`:适合能运行本地命令的 agent,走 CLI 控制路径。
65-
- `codex-pet-mcp`:适合支持 Model Context Protocol 的 agent 或 MCP client。
66-
- `codex-pet-asset`:可选的宠物创建 / 校验流程,只有创建或打包宠物时才需要。
64+
- `openpet-cli`:适合能运行本地命令的 agent,走 CLI 控制路径。
65+
- `openpet-mcp`:适合支持 Model Context Protocol 的 agent 或 MCP client。
66+
- `openpet-asset`:可选的宠物创建 / 校验流程,只有创建或打包宠物时才需要。
6767

68-
日常控制桌宠时,`codex-pet-cli``codex-pet-mcp` 二选一即可。能直接请求 localhost 的 agent 可以使用下方 HTTP API 指引,不需要安装单独的 skill。
68+
日常控制桌宠时,`openpet-cli``openpet-mcp` 二选一即可。能直接请求 localhost 的 agent 可以使用下方 HTTP API 指引,不需要安装单独的 skill。
6969

7070
### Agent Hook 提示
7171

72-
如果想让 OpenPet 和现有 agent 联动,可以在 `AGENTS.md``.cursorrules` 或类似 agent 指令文件里留一条简短规则:让 agent 在长任务中使用已安装的 OpenPet skill,例如 `codex-pet-cli``codex-pet-mcp`,把进度同步给桌宠。
72+
如果想让 OpenPet 和现有 agent 联动,可以在 `AGENTS.md``.cursorrules` 或类似 agent 指令文件里留一条简短规则:让 agent 在长任务中使用已安装的 OpenPet skill,例如 `openpet-cli``openpet-mcp`,把进度同步给桌宠。
7373

7474
如果安装了多个 OpenPet skill,可以让 agent 自己选择一种集成路径,并把选择后的简短规则浓缩写进本地指令文件。规则只需要引用已安装 skill,不需要重复协议或命令细节。
7575

7676
### CLI
7777

7878
```powershell
79-
python skills\codex-pet-cli\scripts\codex_pet_cli.py --help
80-
python skills\codex-pet-cli\scripts\codex_pet_cli.py doctor --json
81-
python skills\codex-pet-cli\scripts\codex_pet_cli.py status --json
82-
python skills\codex-pet-cli\scripts\codex_pet_cli.py event thinking --message "正在阅读仓库..."
83-
python skills\codex-pet-cli\scripts\codex_pet_cli.py import-local public\pets\nia --dry-run --json
84-
python skills\codex-pet-cli\scripts\codex_pet_cli.py import-website https://petdex.crafter.run/pets/boba
79+
python skills\openpet-cli\scripts\openpet_cli.py --help
80+
python skills\openpet-cli\scripts\openpet_cli.py doctor --json
81+
python skills\openpet-cli\scripts\openpet_cli.py status --json
82+
python skills\openpet-cli\scripts\openpet_cli.py event thinking --message "正在阅读仓库..."
83+
python skills\openpet-cli\scripts\openpet_cli.py import-local public\pets\nia --dry-run --json
84+
python skills\openpet-cli\scripts\openpet_cli.py import-website https://petdex.crafter.run/pets/boba
8585
```
8686

87-
给 agent 的规则里可以要求它通过 `codex-pet-cli` skill 查询状态、发送进度事件或导入宠物。CLI 会调用运行中的本地 runtime;如果 OpenPet 不可访问,实时命令会安全失败并给出明确错误,而不是绕过应用私写 app data。
87+
给 agent 的规则里可以要求它通过 `openpet-cli` skill 查询状态、发送进度事件或导入宠物。CLI 会调用运行中的本地 runtime;如果 OpenPet 不可访问,实时命令会安全失败并给出明确错误,而不是绕过应用私写 app data。
8888

8989
### MCP
9090

@@ -95,7 +95,7 @@ MCP bridge 适合支持 Model Context Protocol 的 IDE 或 agent。打开你的
9595
"mcpServers": {
9696
"openpet": {
9797
"command": "python",
98-
"args": ["skills/codex-pet-mcp/scripts/openpet_mcp_server.py"]
98+
"args": ["skills/openpet-mcp/scripts/openpet_mcp_server.py"]
9999
}
100100
}
101101
}
@@ -146,10 +146,10 @@ curl -X POST http://127.0.0.1:17321/api/import/local \
146146
```powershell
147147
pnpm build
148148
cargo test --manifest-path src-tauri/Cargo.toml
149-
python skills\codex-pet-cli\scripts\codex_pet_cli.py --help
150-
python skills\codex-pet-mcp\scripts\openpet_mcp_server.py --help
151-
python skills\codex-pet-cli\scripts\codex_pet_cli.py doctor --json
152-
python skills\codex-pet-cli\scripts\codex_pet_cli.py import-local public\pets\nia --dry-run --json
149+
python skills\openpet-cli\scripts\openpet_cli.py --help
150+
python skills\openpet-mcp\scripts\openpet_mcp_server.py --help
151+
python skills\openpet-cli\scripts\openpet_cli.py doctor --json
152+
python skills\openpet-cli\scripts\openpet_cli.py import-local public\pets\nia --dry-run --json
153153
```
154154

155155
发布检查和打包:

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "openpet",
3-
"version": "0.1.3",
3+
"version": "0.1.4",
44
"private": true,
55
"type": "module",
66
"description": "OpenPet desktop runtime for Codex-compatible pet companions.",
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: codex-pet-asset
2+
name: openpet-asset
33
description: Create, validate, and package Codex-compatible desktop pet assets for OpenPet.
44
---
55

@@ -52,8 +52,8 @@ python scripts\validate_atlas.py <path-to-spritesheet>
5252
6. For local user imports, prefer the CLI:
5353

5454
```powershell
55-
python ..\codex-pet-cli\scripts\codex_pet_cli.py import-local <pet-folder> --dry-run
56-
python ..\codex-pet-cli\scripts\codex_pet_cli.py import-local <pet-folder>
55+
python ..\openpet-cli\scripts\openpet_cli.py import-local <pet-folder> --dry-run
56+
python ..\openpet-cli\scripts\openpet_cli.py import-local <pet-folder>
5757
```
5858

5959
## Runtime Rules
@@ -69,7 +69,7 @@ python ..\codex-pet-cli\scripts\codex_pet_cli.py import-local <pet-folder>
6969

7070
- `validate_atlas.py` reports `ok: true`, or another deterministic atlas check confirms dimensions/grid/cell size.
7171
- `pet.json` uses a safe id and relative `spritesheetPath`.
72-
- Imported packages validate with `python ..\codex-pet-cli\scripts\codex_pet_cli.py import-local <path> --dry-run`.
72+
- Imported packages validate with `python ..\openpet-cli\scripts\openpet_cli.py import-local <path> --dry-run`.
7373
- No white, checkerboard, or opaque rectangular background is visible in used or unused cells.
7474
- The pet shell shows the full `192x208` CSS cell at scale `1`.
7575
- Source, license status, and redistribution caveats are preserved before bundling or sharing assets.
Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: codex-pet-cli
2+
name: openpet-cli
33
description: Use the OpenPet agent CLI protocol to inspect and control the local desktop pet, send status events, and import Codex-compatible local or website pet sources through the running runtime.
44
---
55

@@ -10,12 +10,12 @@ Use this skill when OpenClaw, Codex, or another local agent needs to operate Ope
1010
Default entry point:
1111

1212
```powershell
13-
python scripts\codex_pet_cli.py --help
13+
python scripts\openpet_cli.py --help
1414
```
1515

1616
## Workflow
1717

18-
1. Run `python scripts\codex_pet_cli.py doctor --json` when runtime reachability, app-data assumptions, or local server state matters.
18+
1. Run `python scripts\openpet_cli.py doctor --json` when runtime reachability, app-data assumptions, or local server state matters.
1919
2. Use `status`, `action`, `say`, and `event` for live control through the configured local runtime endpoint.
2020
3. Use `import-local <path>` to ask the running OpenPet runtime to import a local package directory, `pet.json`, or `spritesheet.webp`.
2121
4. Use `import-website <url>` to ask the running OpenPet runtime to import a supported HTTPS website source.
@@ -25,15 +25,15 @@ python scripts\codex_pet_cli.py --help
2525
## Commands
2626

2727
```powershell
28-
python scripts\codex_pet_cli.py --help
29-
python scripts\codex_pet_cli.py doctor --json
30-
python scripts\codex_pet_cli.py status --json
31-
python scripts\codex_pet_cli.py action waving
32-
python scripts\codex_pet_cli.py say "Thinking..." --ttl-ms 4000
33-
python scripts\codex_pet_cli.py event success --message "Tests passed"
34-
python scripts\codex_pet_cli.py import-local public\pets\nia --dry-run --json
35-
python scripts\codex_pet_cli.py import-local <path-to-pet-folder>
36-
python scripts\codex_pet_cli.py import-website https://petdex.crafter.run/pets/boba
28+
python scripts\openpet_cli.py --help
29+
python scripts\openpet_cli.py doctor --json
30+
python scripts\openpet_cli.py status --json
31+
python scripts\openpet_cli.py action waving
32+
python scripts\openpet_cli.py say "Thinking..." --ttl-ms 4000
33+
python scripts\openpet_cli.py event success --message "Tests passed"
34+
python scripts\openpet_cli.py import-local public\pets\nia --dry-run --json
35+
python scripts\openpet_cli.py import-local <path-to-pet-folder>
36+
python scripts\openpet_cli.py import-website https://petdex.crafter.run/pets/boba
3737
```
3838

3939
## Event Contract
@@ -52,7 +52,7 @@ python scripts\codex_pet_cli.py import-website https://petdex.crafter.run/pets/b
5252
- Do not load API details by default.
5353
- Read `references/http-api.md` only when debugging raw HTTP requests, adding routes, or explaining endpoint payloads.
5454
- Read `references/runtime-contract.md` only when changing import behavior, pet package validation, app-data storage, or runtime catalog assumptions.
55-
- Read `scripts/codex_pet_cli.py` only when modifying or debugging the CLI implementation.
55+
- Read `scripts/openpet_cli.py` only when modifying or debugging the CLI implementation.
5656

5757
## Runtime Boundaries
5858

@@ -67,9 +67,9 @@ python scripts\codex_pet_cli.py import-website https://petdex.crafter.run/pets/b
6767
After changing this skill or CLI, run:
6868

6969
```powershell
70-
python scripts\codex_pet_cli.py --help
71-
python scripts\codex_pet_cli.py doctor --json
72-
python scripts\codex_pet_cli.py import-local ..\..\public\pets\nia --dry-run --json
70+
python scripts\openpet_cli.py --help
71+
python scripts\openpet_cli.py doctor --json
72+
python scripts\openpet_cli.py import-local ..\..\public\pets\nia --dry-run --json
7373
```
7474

7575
If Rust runtime contracts changed, also run:

skills/codex-pet-cli/references/http-api.md renamed to skills/openpet-cli/references/http-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Read this only when debugging raw HTTP behavior or changing runtime routes. For normal agent use, prefer:
44

55
```powershell
6-
python scripts\codex_pet_cli.py --help
6+
python scripts\openpet_cli.py --help
77
```
88

99
## Base URL
File renamed without changes.

skills/codex-pet-cli/scripts/codex_pet_cli.py renamed to skills/openpet-cli/scripts/openpet_cli.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -797,7 +797,7 @@ def command_help(args: argparse.Namespace) -> int:
797797

798798
def build_parser() -> argparse.ArgumentParser:
799799
parser = argparse.ArgumentParser(
800-
prog="codex-pet-cli",
800+
prog="openpet-cli",
801801
description="Control OpenPet and import Codex-compatible pet packages through the local runtime.",
802802
)
803803
parser.add_argument("--base-url", help="Runtime base URL, default derived from --port.")
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: codex-pet-mcp
2+
name: openpet-mcp
33
description: Use the OpenPet MCP bridge to inspect and control the local desktop pet, send status events, and import compatible pet sources through the running runtime.
44
---
55

@@ -29,7 +29,7 @@ For MCP clients that accept a stdio server command, point them at:
2929
"mcpServers": {
3030
"openpet": {
3131
"command": "python",
32-
"args": ["skills/codex-pet-mcp/scripts/openpet_mcp_server.py"]
32+
"args": ["skills/openpet-mcp/scripts/openpet_mcp_server.py"]
3333
}
3434
}
3535
}
@@ -43,7 +43,7 @@ If OpenPet is using a non-default HTTP endpoint, pass it explicitly:
4343
"openpet": {
4444
"command": "python",
4545
"args": [
46-
"skills/codex-pet-mcp/scripts/openpet_mcp_server.py",
46+
"skills/openpet-mcp/scripts/openpet_mcp_server.py",
4747
"--base-url",
4848
"http://127.0.0.1:17322"
4949
]

0 commit comments

Comments
 (0)