A pixel desktop buddy that reacts to Claude Code in real time
Project description
claudlet 🐾
English | 한국어
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).
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.
Real desktop capture — they wander over whatever else is on your screen.
Agent companions
When Claude spawns subagents, a little hard-hatted sidekick trails your pet for each one — a duckling chain that follows it around, mirrors what the subagent is doing, and waves goodbye when its agent finishes.
Real desktop capture — two subagents, two hatted companions trailing the session's pet.
Each companion wears a random hat so you can tell them apart:
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, 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.
When Claude runs subagents, a hatted companion appears for each one (up to three) and trails the pet in a duckling chain, mirroring the subagent's activity and leaving with a little celebration when it finishes — so you can see agent work happening at a glance.
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(pluslist,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 latestfor 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-configor/claudlet configto locate & inspect it) - Platform support — support matrix + how to test on your OS
- Changelog — what changed in each release (English + Korean)
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file claudlet-0.3.1.tar.gz.
File metadata
- Download URL: claudlet-0.3.1.tar.gz
- Upload date:
- Size: 117.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dcf747c67441a2f64e494f5e983ec0b870fd358318d2be44e28a943698ce838c
|
|
| MD5 |
74734fd16fb41f31e1da48cafad92f61
|
|
| BLAKE2b-256 |
cc6abcc957ae0b29ddc9d4b0c11491d36cf3f96f1ee1f14b133e622757df6abd
|
Provenance
The following attestation bundles were made for claudlet-0.3.1.tar.gz:
Publisher:
publish.yml on YeeDochi/Claudlet
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
claudlet-0.3.1.tar.gz -
Subject digest:
dcf747c67441a2f64e494f5e983ec0b870fd358318d2be44e28a943698ce838c - Sigstore transparency entry: 2145949996
- Sigstore integration time:
-
Permalink:
YeeDochi/Claudlet@179608d7c8b8f034b1b3ac3a3ed96bfeae0952a2 -
Branch / Tag:
refs/tags/v0.3.1 - Owner: https://github.com/YeeDochi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@179608d7c8b8f034b1b3ac3a3ed96bfeae0952a2 -
Trigger Event:
push
-
Statement type:
File details
Details for the file claudlet-0.3.1-py3-none-any.whl.
File metadata
- Download URL: claudlet-0.3.1-py3-none-any.whl
- Upload date:
- Size: 95.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5f7b725b38070c429941c002be15178a2ff9c4bcc713339c0027351ebfb9fd2f
|
|
| MD5 |
6236565d4f9892f02c1780064af9561b
|
|
| BLAKE2b-256 |
0330484da74abb7b7c4fb84d69050136ff352011f120b57fbaba5b72b17933f8
|
Provenance
The following attestation bundles were made for claudlet-0.3.1-py3-none-any.whl:
Publisher:
publish.yml on YeeDochi/Claudlet
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
claudlet-0.3.1-py3-none-any.whl -
Subject digest:
5f7b725b38070c429941c002be15178a2ff9c4bcc713339c0027351ebfb9fd2f - Sigstore transparency entry: 2145950005
- Sigstore integration time:
-
Permalink:
YeeDochi/Claudlet@179608d7c8b8f034b1b3ac3a3ed96bfeae0952a2 -
Branch / Tag:
refs/tags/v0.3.1 - Owner: https://github.com/YeeDochi
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@179608d7c8b8f034b1b3ac3a3ed96bfeae0952a2 -
Trigger Event:
push
-
Statement type: