harivansh-afk/deskctl
1
1
Fork 0
mirror of https://github.com/harivansh-afk/deskctl.git synced 2026-04-15 07:04:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

edit readme

Browse source
This commit is contained in:
Harivansh Rathi 2026-03-26 09:34:10 -04:00
parent bf603671f9
commit 848ef97e87
1 changed files with 7 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -1,11 +1,9 @@
# deskctl # deskctl
[![npm](https://img.shields.io/npm/v/deskctl?label=npm)](https://www.npmjs.com/package/deskctl) [![npm](https://img.shields.io/npm/v/deskctl?label=npm)](https://www.npmjs.com/package/deskctl)
[![release](https://img.shields.io/github/v/release/harivansh-afk/deskctl?label=release)](https://github.com/harivansh-afk/deskctl/releases)
[![runtime](https://img.shields.io/badge/runtime-linux--x11-111827)](#support-boundary)
[![skill](https://img.shields.io/badge/skills.sh-deskctl-111827)](skills/deskctl) [![skill](https://img.shields.io/badge/skills.sh-deskctl-111827)](skills/deskctl)
Non-interactive desktop control for AI agents on Linux X11. Desktop control cli for AI agents on Linux X11.
## Install ## Install
@ -15,44 +13,19 @@ deskctl doctor
deskctl snapshot --annotate deskctl snapshot --annotate
``` ```
One-shot execution also works: ## Skill
```bash ```bash
npx deskctl --help npx skills add harivansh-afk/deskctl
```
`deskctl` installs the command by downloading the matching GitHub Release asset for the supported runtime target.
## Installable skill
```bash
npx skills add harivansh-afk/deskctl --skill deskctl -g
```
The installable skill lives in [`skills/deskctl`](skills/deskctl), follows the
standard `skills/` repo layout, and installs directly from this GitHub repo via
`npx skills add ...`. It is built around the same observe -> wait -> act ->
verify loop as the CLI.
## Quick example
```bash
deskctl doctor
deskctl snapshot --annotate
deskctl wait window --selector 'title=Firefox' --timeout 10
deskctl focus 'title=Firefox'
deskctl type "hello world"
``` ```
## Docs ## Docs
- runtime contract: [docs/runtime-contract.md](docs/runtime-contract.md) - runtime contract: [docs/runtime-contract.md](docs/runtime-contract.md)
- release flow: [docs/releasing.md](docs/releasing.md) - releasing: [docs/releasing.md](docs/releasing.md)
- installable skill: [skills/deskctl](skills/deskctl) - contributing: [CONTRIBUTING.md](CONTRIBUTING.md)
- contributor workflow: [CONTRIBUTING.md](CONTRIBUTING.md)
## Other install paths ## Install paths
Nix: Nix:
@ -61,12 +34,8 @@ nix run github:harivansh-afk/deskctl -- --help
nix profile install github:harivansh-afk/deskctl nix profile install github:harivansh-afk/deskctl
``` ```
Source build: Rust:
```bash ```bash
cargo build cargo build
``` ```
## Support boundary
`deskctl` currently supports Linux X11. Use `--json` for stable machine parsing, use `window_id` for programmatic targeting inside a live session, and use `deskctl doctor` first when the runtime looks broken.