Skip to content
OpenPets paw badgeOpenPets Docs
Esc
↑↓navigate↵open⌘Jpreview
On this page

OpenPets CLI

Use @open-pets/cli to configure agent integrations, run MCP, send pet reactions, scaffold plugins, and validate plugin packages.

The OpenPets CLI is published as @open-pets/cli. It talks to the running desktop app through the local IPC client and also manages project setup for supported coding tools.

Run it without installing globally:

npx @open-pets/cli --help

Common commands

Command Purpose
openpets configure Configure Claude Code, OpenCode, or Cursor for a project, OpenCode globally with --global, or ensure the global OpenClaw plugin is installed and enabled.
openpets doctor Read-only diagnostics for Claude hooks, Cursor project MCP, global OpenCode setup, and app reachability.
openpets status Check whether the desktop app is reachable.
openpets pets List installed pets from the desktop app.
openpets react <reaction> Send a reaction to the current pet.
openpets say <message> Show a pet speech bubble, optionally with a reaction.
openpets mcp Run the MCP server wrapper for generic clients.
openpets plugin new <name> Scaffold an SDK v3 plugin package.
openpets plugin validate <dir> Validate a local plugin manifest/package boundary.

Configure a project

npx @open-pets/cli configure

The configure command can set up Claude Code hooks/MCP, OpenCode project-local config by default or shared global config with --global, Cursor MCP/rules, or the global OpenClaw native plugin depending on the selected target. --global is only supported with --agent opencode and cannot be combined with an explicit --cwd. Both CLI global setup and desktop setup resolve the shared config directory through the same getGlobalOpenCodeConfigDir() logic. For OpenClaw, use:

npx @open-pets/cli configure --agent openclaw --yes

OpenClaw setup is global and accepts no project directory, pet, force, local-dev, or Cursor-rules options. The CLI checks OpenClaw version/list/inspect state, applies the required install or update and enable commands, then refreshes the status before reporting success. Direct OpenClaw inventory and removal remain owned by the native CLI (openclaw plugins list, openclaw plugins inspect, and openclaw plugins uninstall). See Agent integrations.

Run MCP directly

npx @open-pets/cli mcp

Use this command as the stdio MCP server command for clients that do not have a dedicated OpenPets integration. See MCP.

Send a reaction

npx @open-pets/cli react thinking
npx @open-pets/cli say "Tests passed" --reaction success

The desktop app validates reaction names and routes messages through its local IPC lease model. See Local IPC.

Scaffold a plugin

npx @open-pets/cli plugin new "My Plugin" --template reminder

Available SDK v3 templates are:

  • blank
  • reminder
  • ambient
  • ai-chat
  • tamagotchi
  • calendar

Validate a plugin before packaging or submitting it:

npx @open-pets/cli plugin validate ./my-plugin

The validator mirrors desktop install-time checks while the desktop runtime remains authoritative. See Plugin SDK v3 and Plugin platform.

Was this page helpful?