Metadata-Version: 2.5
Name: deskpilot
Version: 0.3.0
Summary: Desktop control for agents on Hyprland: window-relative clicks that leave the user's pointer alone, and typing
Project-URL: Homepage, https://github.com/cjber/deskpilot
Project-URL: Repository, https://github.com/cjber/deskpilot
Project-URL: Issues, https://github.com/cjber/deskpilot/issues
Project-URL: Changelog, https://github.com/cjber/deskpilot/blob/main/CHANGELOG.md
Author-email: Cillian Berragan <cjberragan@gmail.com>
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: evdev>=1.7
Requires-Dist: mcp>=2.3
Requires-Dist: pillow>=10
Description-Content-Type: text/markdown

# deskpilot

Desktop control for agents on Hyprland. An agent takes a screenshot of a window, picks a point in it, and clicks
or types there, in any app: native Wayland, XWayland and Wine programs such as the Battle.net launcher and games.

The user keeps their own pointer and keyboard focus. Clicks, scrolls and keys run inside the compositor through
the deskpilot Hyprland plugin: in one step it holds the user's mouse input, delivers the event to the target window
through the user's own seat, then puts the pointer back where it was, applying any mouse motion the user made
meanwhile. Only pointer focus moves, so keyboard focus stays on the user's window and the target is not raised, even
with `focus_on_activate` set. Wayland, XWayland and Wine clients all receive the press as a real click. The plugin refuses
a click when another window covers the point.

An agent cursor shows where deskpilot acts: [cua-driver](https://github.com/trycua/cua)'s overlay arrow glides to
each point, drawn above every window and separate from the user's pointer. Without `cua-driver` on `PATH`, or with
`DESKPILOT_CURSOR=off`, actions run without it.

Keys sent to a window (`--window`) go to that window only, with each stroke complete before focus returns, and
the user's modifiers never leak into them. X11 apps take keys only from the window with X input focus, so an
XWayland target gets X focus for each stroke and sees a focus-in and focus-out around it; Hyprland's own focus
does not move.

Text is typed as written on the user's own keymap, whatever its layout and with Caps Lock on: the plugin finds the
key that gives each character on the active keyboard's keymap, which every client has, and sets the modifiers it
needs directly. A character no key on that keymap gives is an error rather than skipped.

`--take-pointer` uses a virtual mouse made with `/dev/uinput` instead, which the compositor treats as real
hardware. Tools that synthesize input another way, such as `xdotool` (XTest), are ignored by some clients:
Battle.net drops `xdotool` clicks.

## Requirements

- Hyprland, with `hyprctl` on `PATH`. Version 0.57's Lua dispatchers and the older string ones both work.
- The plugin build tools: a C++26 compiler, `make`, Hyprland's headers (`pkg-config hyprland`, shipped with
  Arch's `hyprland` package), `libxcb` and `libxkbcommon`.
- Optional: `cua-driver` for the agent cursor.
- `grim` for screenshots.
- `wl-clipboard` for `clipboard`.
- For `--take-pointer`: write access to `/dev/uinput`, usually through the `input` group or a udev ACL. Check with
  `test -w /dev/uinput`.
- Python 3.12 or later and `uv`.

## Install

```sh
uv tool install deskpilot
```

The agent skill, which teaches an agent the steps below, installs in Claude Code with:

```text
/plugin install deskpilot --marketplace cjber/deskpilot
```

## Use

```sh
deskpilot windows                         # every window: address, class, title, geometry, whether on screen
deskpilot shot battle.net.exe             # screenshot; prints its id, image path and scale
deskpilot click battle.net.exe 920 367 --shot ID    # a point in that screenshot
deskpilot type "/reload" --window wow.exe --delay 0.12
deskpilot key ctrl+a --window kitty
deskpilot paste "Grüße, 日本" --window firefox    # any text, through a clipboard only that window sees
deskpilot clipboard                       # the user's clipboard text; --set TEXT replaces it
deskpilot wait-for wow.exe --timeout 120
deskpilot wait-for wow.exe --changed ID --region 0 0 400 80   # until that part of shot ID looks different
```

A window is named by its address, its class, or a substring of its class or title. A name that matches more
than one window is an error listing them, so a click never lands on a guessed window.

`shot` captures the window itself, so a window on top does not show in it, and saves it under an id. `move`,
`click` and `scroll` take pixels in the shot named by `--shot`, or the window's latest one, whatever scale it was
taken at. A window resized since that shot is refused, as is a point outside the window. Pass `--scale 1` to give
window pixels instead.

A window on a hidden workspace or scrolled off its monitor is reported as `"visible": false`, and `shot`, `move`,
`click` and `scroll` refuse it rather than move the user's view. `--show` focuses it to bring it on screen first.

The first action that needs the plugin builds and loads it for the running Hyprland, so it comes back by itself
after Hyprland restarts or upgrades. `deskpilot plugin load` does the same ahead of time.

Some apps close a menu or dropdown as soon as it opens when their window is not the focused one, as Chrome does
with many web page dropdowns. `click --take-focus` focuses the window first and leaves it focused, so the list stays
open for the next click.

`move` only shows the agent cursor. Pass `--take-pointer` to `move`, `click` or `scroll` to move the user's own
pointer there and press through the input device instead, for a hover the app must see.

A shell started before Hyprland restarted keeps a stale `HYPRLAND_INSTANCE_SIGNATURE`. deskpilot then talks to
the one instance whose socket answers, and with several live instances it stops and names them.

`key` and `type` without `--window` press keys into the focused window. `--take-focus` focuses the window first and
leaves it focused, for an app that ignores keys while unfocused. Keys go to the window's client, not through the
compositor, so they never trigger a Hyprland keybind: use `hyprctl dispatch` for those.

`paste` hands text to a window as a clipboard only that window sees, then presses its paste chord (`--keys`,
`ctrl+v` by default; most terminals want `ctrl+shift+v`). It pastes any text, including characters the keymap cannot
type, and the user's clipboard stays as it is. XWayland windows share one clipboard, so `paste` refuses them: use
`type`. `clipboard` reads the user's clipboard, and `clipboard --set` replaces it.

Games read keys once per frame, so type into them with `--delay 0.1` or more: each key is held that long, with the
same gap before the next.

`wait-for` waits for a window to appear, or with `--gone` to close. `--focused`, `--title TEXT` and `--size WxH` also
wait for it to have keyboard focus, a title containing TEXT or that size. `--changed SHOT` waits until the window
looks different from one of its shots, in all of it or in `--region X Y W H` of that shot's pixels: any pixel
difference counts, and it prints a shot of the change with the box that changed.

Clicks, scrolls and keys from several agents at once run one after another in the order they arrive, so one `type`
is never interleaved with another's keys. Up to 32 wait behind the running one; past that an action is refused.

## MCP

`deskpilot mcp` serves the same actions over stdio: `windows`, `focus`, `shot` (returns the image and its shot
id), `click`, `move`, `scroll`, `key`, `type_text`, `paste_text`, `clipboard`, `copy_text`, `wait_for` and
`wait_changed`. `click`, `move` and `scroll` take `shot`, `show` and `take_pointer`; `click`, `key`, `type_text` and
`paste_text` take `take_focus`. It keeps one input device and one agent cursor open for the session.

```sh
claude mcp add deskpilot -- deskpilot mcp
```

## Limits

- `type` can only send characters the active keymap types; a character it lacks (such as `é` on a US layout) is
  an error rather than skipped. `paste` takes any text, except into XWayland windows.
- Hyprland plugins load only into the exact Hyprland they were built against, so `deskpilot plugin load` builds
  one per Hyprland commit and plugin source under `~/.local/share/deskpilot`, and replaces a loaded build of
  other source.
- Each CLI action that uses the input device opens a new one and waits about a second for libinput to add it. The MCP server
  avoids that wait.
- Hyprland only, Linux only.

## Development

[AGENTS.md](AGENTS.md) has the checks, the layout and the rules a change must keep, and
[CONTRIBUTING.md](CONTRIBUTING.md) how to report a bug or send a change.
