How to use petdex
Mirrors DeepSeek Harness Web session lifecycle events to the Petdex desktop floating window, allowing the desktop pet to switch animations based on DSH task status. macOS only.
This article is auto-derived from indexed fields (wiki / faq / compatibility_json), not freshly AI-generated.
This article is derived from the plugin's already-indexed fields (wiki / faq / compatibility_json / readme), not freshly generated by AI. Source field is noted at the end of each section.
Quick start
petdex
— source: plugin_wiki.wiki_content
Install & verify
dsh plugin --profile web add github:crafter-station/petdex#path:packages/petdex-desktop-native/integrations/dsh
Run the command above in your DSH Web Profile. Then enable the plugin in the plugin list.
— source: plugins.install
Key points
- The HTTP API.
petdex.dev/api/manifestreturns every approved pet with its slug, spritesheet URL, animation states, and metadata. - The pet package format. Every pet is a
pet.jsonplus aspritesheet.{webp,png}rendered as an 8x9 grid of 192x208 frames, or the v2 8x11 grid. - Submit a pet: petdex.dev/submit or
npx petdex submit <path>. - List your project: open a Built with Petdex issue.
- Fix a bug or add a feature: read
CONTRIBUTING.md, then open a PR.
— source: plugin_wiki.readme_en (fallback readme_raw)
FAQ
After installation, why does Petdex still show "Restart DSH Web"?
This plugin is a Cordis bundle and cannot be hot-reloaded by DSH. After successful installation, you must manually restart npx @deepseek-ai/dsh web once, then start or continue a real task. Only then will Petdex read the handshake information from ~/.petdex/runtime/dsh-handshake.json and show Connected. Simply opening DSH does not trigger any events, and the handshake will not complete.
Will the plugin send my prompts, tool parameters, and model outputs to Petdex?
No. The plugin only listens to official session lifecycle events. After normalization, it projects only 5 states (jumping/running/waiting/waving/failed), display text, session ID, sequence number, and event type. Prompts, tool parameters, model outputs, and approval contents are all discarded. POST requests are only sent to localhost 127.0.0.1:7777 and require token authentication from ~/.petdex/runtime/update-token.
Clicking the pet should jump to the current DSH session, why does it only open the default browser?
V1 does not have precise browser tab positioning capabilities. Clicking the pet only activates the current macOS default browser, it will not jump to any URL, open new tabs, or distinguish which tab DSH occupies. This is intentionally preserved fallback behavior, not a bug.
I installed DSH in a custom directory (DSH_HOME points to non-~/.dsh), how do I configure this?
Set DSH_HOME with the same name in the Petdex process environment. Petdex launched from Finder will not inherit variables that are only exported in interactive shells; if DSH uses a custom home, you need to inject DSH_HOME into the environment visible to the Petdex process before installation, otherwise Petdex won't be able to find the profile.
After uninstalling, the plugin is still visible in DSH Web, what should I do?
The uninstall command only calls dsh plugin --profile web remove @petdex/dsh-plugin and will not clear DSH profiles, sessions, models, or other plugins. After uninstallation completes, you also need to manually restart DSH Web once to let the running process unload the plugin bundle.
Installation command reports "Plugin command failed - check npx and network" - how to troubleshoot?
The desktop runs npx --package=@deepseek-ai/[email protected] [email protected] dsh plugin --profile web add and requires npx and access to the npm registry. Installing pnpm globally is not required (the command includes an embedded version). Errors usually mean the shell launched from Finder did not inherit PATH, the registry is inaccessible, or the tarball hash verification failed (the desktop will clear the handshake and report an error).
Can this plugin be used on Linux or Windows?
No. Petdex desktop itself is cross-platform, but the DSH integration is a macOS-first initial release (agent_hooks.zig comments explicitly state "DSH Web is macOS-only in the first integration slice"). On Linux/Windows, the DeepSeek Harness line in Petdex Settings will only show "Not detected".
— source: plugin_wiki.faq_json
Compatibility
- DSH: 0.1.0-rc.6
- Node: 未声明
— source: plugin_wiki.compatibility_json
Pitfalls
Review the upstream repo before installing. This guide is auto-derived from indexed fields and may lag the latest release. If anything contradicts the official docs, treat the upstream source as authoritative.
— source: general rule