Skip to main content

A pixel desktop buddy that reacts to Claude Code in real time

Project description

claudlet 🐾

English | 한국어

PyPI

A tiny pixel creature that lives on your desktop and reacts to Claude Code in real time — it types while Claude works, waits when Claude needs you, celebrates when it's done, and roams around while you code. Click it to bring the terminal back to the front.

Drawn entirely in code — no image assets — so it's self-contained and original (CC0 artwork).

states

See it in action

Real desktop capture. Pets perch on the terminal titlebar, roam the desktop, doze off (💤) between tasks, and clamber over whatever else is on screen.

claudlet on the desktop

Pets perch on the terminal and roam the desktop Perching on the terminal, roaming, and dozing between tasks.

Dragging a pet while the others nap Grab and drag them around; the rest keep roaming and napping.

Pets roaming over the wallpaper They wander over whatever else is on your screen.

Install

Install with pipx (an isolated app install — pulls the deps, incl. pyobjc-framework-Quartz on macOS, and puts the claudlet* commands on your PATH), then wire it into Claude Code:

pipx install claudlet
claudlet-install      # registers the hooks + /claudlet skill (idempotent)

Check your version with claudlet-version (installed vs latest release). Update to the newest release with pipx upgrade claudlet && claudlet-install, or to the tip of develop (edge) with pipx install --force "git+https://github.com/YeeDochi/Claudlet@develop" && claudlet-install. Either way, restart your Claude Code session afterward (claude --continue) so the new hooks + pet code load. Or just run /claudlet update (release) / /claudlet update latest (master) from inside Claude Code and follow the prompts.

Remove it with claudlet-uninstall (stops pets, unregisters the hooks + skill; add --purge to also delete your config), then pipx uninstall claudlet.

Without pipx — one-line source install

Clones (or updates) to ~/claudlet, installs deps, registers hooks + skill:

# Linux / macOS
curl -fsSL https://raw.githubusercontent.com/YeeDochi/Claudlet/master/install.py | python3 -
# Windows (PowerShell)
irm https://raw.githubusercontent.com/YeeDochi/Claudlet/master/install.py | python -

New Claude Code sessions then auto-spawn a pet. Restart any already-running session to pick up the hooks — or launch one now with claudlet.

Best on KDE Plasma. Perching on and riding windows also works on Windows (Win32) and macOS (experimental — needs pyobjc-framework-Quartz, which the installer adds automatically; the pet self-calibrates window coordinates at runtime). Elsewhere the window tricks switch off gracefully and the pet just roams. See Platform support.

What it shows

The creature's pose tracks what Claude is doing — editing, reading, calling MCP, spawning subagents, thinking, waiting on your input, celebrating (see the sheet above). In auto / bypass mode it puts on a VR visor and cruises, with a per-tool variant for each activity. It also perches on and rides your windows — walking along the top or living inside — and clips/hides when the window it's on is covered or minimized.

Commands

pipx install claudlet puts these on your PATH:

Command What it does
claudlet Launch a pet right now (standalone).
claudlet-install Register the hooks + /claudlet skill in Claude Code — run once after installing.
claudlet-uninstall Stop pets, unregister the hooks + skill, clean up (--purge also deletes your config).
claudlet-config Show / scaffold / open the user config (--path, init, open).
claudlet-version Show the installed version vs the latest PyPI release.
claudlet-attach Attach a pet to the current Claude Code session.
claudlet-motion <name> Play a motion on running pets (jump, wave, … ; stop, list).
claudlet-install-hooks Just the hooks half of claudlet-install (--remove to undo).
claudlet-macos-diag Print raw macOS window coordinates (perch troubleshooting).
claudlet-hook Internal — invoked by Claude Code's hooks, not by you.

The /claudlet skill

claudlet-install also links a /claudlet skill into Claude Code, so you can drive the pet straight from a prompt:

  • /claudlet — attach a pet to this session (so it reacts to the session's activity)
  • /claudlet standalone — an unattached, decorative pet
  • /claudlet <motion>jump · wave · sing · juggle · float · celebrate · thinking · sleeping · error · attention (plus list, stop)
  • /claudlet config — show the config, or just ask in plain language ("jump when I run Bash") and Claude edits it for you
  • /claudlet update — update to the latest release (update latest for the tip of develop); shows your version and walks you through it

Docs

  • Usage & interaction — drag & throw, click-to-focus, tray menu, motions, autostart, uninstall
  • Configuration — remap which animation shows for which Claude Code activity (run claudlet-config or /claudlet config to locate & inspect it)
  • Platform support — support matrix + how to test on your OS

License

Code: MIT (see LICENSE). Creature artwork: CC0 (see NOTICE).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

claudlet-0.2.0.tar.gz (101.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

claudlet-0.2.0-py3-none-any.whl (82.9 kB view details)

Uploaded Python 3

File details

Details for the file claudlet-0.2.0.tar.gz.

File metadata

  • Download URL: claudlet-0.2.0.tar.gz
  • Upload date:
  • Size: 101.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for claudlet-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b1dd6f9538a442da988948a17143cdb30cc34c2c72a9f81dcf4b98bea078ecf2
MD5 3724d80e89498a9c0289a4106fc1292f
BLAKE2b-256 d994bb7d8987c11705dcc08a998f6a8b1e98716164311cfa67479b7551ef1a99

See more details on using hashes here.

Provenance

The following attestation bundles were made for claudlet-0.2.0.tar.gz:

Publisher: publish.yml on YeeDochi/Claudlet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file claudlet-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: claudlet-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 82.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for claudlet-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b4e5829d1ae3badfe0878e9bd7092cbae4967e755a4a74f1b88126ab62c9fef9
MD5 0550ea74b108cf737f62ef71f0f2c6b3
BLAKE2b-256 a3fb7df13f4357f92ed2143f3fc0938ff9efbcb6e3000223e5c9c33dabb732e1

See more details on using hashes here.

Provenance

The following attestation bundles were made for claudlet-0.2.0-py3-none-any.whl:

Publisher: publish.yml on YeeDochi/Claudlet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page