Back to Details

openpets

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

OpenPets

OpenPets

OpenPets is a desktop companion app for coding agents. The desktop app runs locally and exposes pet controls through CLI, MCP, hooks, plugins, and local IPC.
Use this skill to help users onboard quickly and safely:
  • install or verify the OpenPets desktop app
  • install pets from the public catalog
  • configure Claude Code, OpenCode, Cursor, Codex, or another MCP client
  • configure a project to use a specific pet
  • validate 
    openpets_status
    , 
    openpets_react
    , and 
    openpets_say
  • explain how OpenPets works
  • troubleshoot setup problems
OpenPets 是一款面向编码Agent的桌面陪伴应用。该桌面应用在本地运行，通过CLI、MCP、钩子、插件和本地IPC提供宠物控制功能。
使用此技能帮助用户快速且安全地上手：
  • 安装或验证OpenPets桌面应用
  • 从公共目录安装宠物
  • 配置Claude Code、OpenCode、Cursor、Codex或其他MCP客户端
  • 配置项目以使用特定宠物
  • 验证
    openpets_status
    、
    openpets_react
    和
    openpets_say
    命令
  • 解释OpenPets的工作原理
  • 排查安装设置问题

CLI rule: install once, then use openpets

CLI规则：先安装，再使用openpets

For the cleanest onboarding, install the OpenPets CLI globally first:
bash
npm install -g @open-pets/cli
Then use the 
openpets
command:
bash
openpets <command>
If the user does not want a global install, is in CI, or only needs a one-off command, use this fallback instead:
bash
npx -y @open-pets/cli@latest <command>
For MCP server config, prefer the dedicated MCP package:
bash
npx -y @open-pets/mcp@latest --pet <pet-id>
Do not imply the desktop app installs a shell command by itself. The 
openpets
command comes from the optional npm global CLI install.
为了获得最顺畅的上手体验，请先全局安装OpenPets CLI：
bash
npm install -g @open-pets/cli
然后使用
openpets
命令：
bash
openpets <command>
如果用户不想全局安装、处于CI环境中或只需要一次性命令，请改用以下备选方案：
bash
npx -y @open-pets/cli@latest <command>
对于MCP服务器配置，优先使用专用的MCP包：
bash
npx -y @open-pets/mcp@latest --pet <pet-id>
不要暗示桌面应用会自行安装shell命令。
openpets
命令来自可选的npm全局CLI安装。

Mental model

心智模型

text
Claude/OpenCode/Codex/Cursor/MCP client
  -> OpenPets MCP, plugin, hook, or CLI
  -> @open-pets/client
  -> local IPC discovery/token
  -> OpenPets desktop app
  -> default pet or selected agent pet lease
OpenPets requires the desktop app to be installed and running for live pet control.
text
Claude/OpenCode/Codex/Cursor/MCP客户端
  -> OpenPets MCP、插件、钩子或CLI
  -> @open-pets/client
  -> 本地IPC发现/令牌
  -> OpenPets桌面应用
  -> 默认宠物或选定的Agent宠物租赁
OpenPets需要桌面应用已安装并运行才能实现实时宠物控制。

Decision tree

决策树

  • User asks to install OpenPets: follow 
    workflows/install-openpets.md
    .
  • User asks to install a pet: follow 
    workflows/install-pet.md
    .
  • User asks to configure a project or agent: follow 
    workflows/configure-project.md
    .
  • User asks to verify Claude Code: follow 
    workflows/verify-claude.md
    .
  • User asks to verify OpenCode: follow 
    workflows/verify-opencode.md
    .
  • User asks about MCP or tool availability: follow 
    workflows/verify-mcp.md
    .
  • User reports something broken: follow 
    workflows/troubleshoot.md
    .
  • User asks how OpenPets works: follow 
    workflows/explain-architecture.md
    .
  • 用户要求安装OpenPets：遵循
    workflows/install-openpets.md
    流程。
  • 用户要求安装宠物：遵循
    workflows/install-pet.md
    流程。
  • 用户要求配置项目或Agent：遵循
    workflows/configure-project.md
    流程。
  • 用户要求验证Claude Code：遵循
    workflows/verify-claude.md
    流程。
  • 用户要求验证OpenCode：遵循
    workflows/verify-opencode.md
    流程。
  • 用户询问MCP或工具可用性：遵循
    workflows/verify-mcp.md
    流程。
  • 用户报告故障：遵循
    workflows/troubleshoot.md
    流程。
  • 用户询问OpenPets工作原理：遵循
    workflows/explain-architecture.md
    流程。

Safety rules

安全规则

  • Prefer official OpenPets CLI/UI flows over hand-editing integration config.
  • Ask before using 
    --force
    or replacing existing user-managed MCP/plugin/hook config.
  • Confirm the project path before project-local configuration.
  • Confirm the pet id before installing or selecting a pet, and make sure it is installed before configuring a project to use it.
  • Do not put secrets, private logs, private paths, source code, URLs, credentials, or sensitive text into pet speech.
  • Restart Claude Code, OpenCode, or other MCP clients after config changes.
  • Do not promise the desktop app is installed or running; verify it.
  • If setup still fails after normal troubleshooting, encourage the user to report a bug at the OpenPets GitHub repository: https://github.com/alvinunreal/openpets/issues
  • 优先使用官方OpenPets CLI/UI流程，而非手动编辑集成配置。
  • 在使用
    --force
    或替换用户管理的现有MCP/插件/钩子配置前，先询问用户。
  • 在进行项目本地配置前，确认项目路径。
  • 在安装或选择宠物前确认宠物ID，并确保宠物已安装后再配置项目使用它。
  • 不要将机密信息、私有日志、私有路径、源代码、URL、凭据或敏感文本放入宠物语音中。
  • 配置更改后重启Claude Code、OpenCode或其他MCP客户端。
  • 不要默认假设桌面应用已安装或运行；需进行验证。
  • 如果经过常规排查后设置仍失败，鼓励用户在OpenPets GitHub仓库提交bug：https://github.com/alvinunreal/openpets/issues

Canonical quick commands

标准快速命令

bash
npm install -g @open-pets/cli
openpets status
openpets pets
openpets install <pet-id>
openpets configure --agent claude --pet <pet-id> --cwd <project-path> --yes
openpets configure --agent opencode --pet <pet-id> --cwd <project-path> --yes
openpets configure --agent cursor --pet <pet-id> --cwd <project-path> --yes
openpets mcp --pet <pet-id>
One-off fallback: replace 
openpets
with 
npx -y @open-pets/cli@latest
.
MCP server command:
bash
npx -y @open-pets/mcp@latest --pet <pet-id>
bash
npm install -g @open-pets/cli
openpets status
openpets pets
openpets install <pet-id>
openpets configure --agent claude --pet <pet-id> --cwd <project-path> --yes
openpets configure --agent opencode --pet <pet-id> --cwd <project-path> --yes
openpets configure --agent cursor --pet <pet-id> --cwd <project-path> --yes
openpets mcp --pet <pet-id>
一次性备选方案：将
openpets
替换为
npx -y @open-pets/cli@latest
。
MCP服务器命令：
bash
npx -y @open-pets/mcp@latest --pet <pet-id>

Public resources

公共资源

Use the docs on 
openpets.dev
as the source of truth when details may have changed.
当细节可能发生变化时，请以
openpets.dev
上的文档为权威来源。