Browse the handbook

For developers

Cleat's developer toolkit: JSON, JWT, cron, HTTP status and regex answers in the field, ports, Xcode simulators, Docker containers and SSH hosts as commands, git actions on folders, and a shell one keystroke away.

Cleat toolsUpdated

Everything here works without leaving the palette, and everything that runs a tool only runs it when you press Return.

Answers in the field

Type Get
{"b":1,"a":[1,2]} or any JSON A pretty copy with sorted keys and a minified copy. json, pretty and format prefixes also work
jwt eyJ… or the token alone The payload and header as JSON, and exp, iat, nbf as dates with expired or valid. The signature is not verified
cron 0 9 * * 1-5 “At 09:00 on Monday to Friday”. Steps, lists, ranges, month and weekday names
http 404, status 503, 418 status The name and meaning of the code
regex (\w+)@(\w+) :: me@example Each match with its numbered groups; pattern before ::, text after
uuid, now, 1700000000, base64 hi, sha256 abc, urlencode a b, 255 in hex See Instant answers
password 24, pin 6 Random values from the system generator

Commands

These ship as scripts in ~/.config/cleat/commands, so you can read and edit them. Settings › Commands shows whether their dependencies are installed.

Keyword Does
port 3000, port node What is listening on which TCP port, from lsof. Return stops the process, SIGTERM first and SIGKILL two seconds later if it is still there
sim iphone 17 Xcode simulators, booted ones first. Return boots one and opens Simulator on it
docker postgres Containers with image, state and ports. Return stops a running one or starts a stopped one
p cleat Folders in your projects directory, newest first, with the git branch. Settings › Commands sets the folder and the app to open with, for example Visual Studio Code, Xcode or Zed
gh cleat Your GitHub repositories, through the gh CLI
kill node Force quit a process by name; top is the Activity Monitor with quit and force quit

Built in

  • SSH to …: every concrete Host in ~/.ssh/config is a row; Return opens ssh host in Terminal. Type ssh to see them all.
  • Clear Xcode DerivedData: moves every build folder to the Trash after asking.
  • Git folders: ⌘K on a folder that is a repository adds Open Repository on GitHub (or whatever the remote host is), Open Pull Requests or Merge Requests, Copy Branch Name, Open Branch on GitHub and Show Git Status. Type ~/Development/cleat to reach a folder, or find it through p.
  • Open in Terminal on any folder, in the terminal you already run.

The shell and paths

> git status runs in your login shell with the output in the palette; ⌘⏎ runs it in Terminal. ~/Development/ lists a folder and ~/Dev completes it. recent lists the files you opened lately. See Shell, paths and recent files.

Writing your own

Any executable that prints JSON lines is a command: a manifest in a comment, a keyword, a --run branch. Ten minutes in any language. See Extensions and the protocol reference, and the command directory for ones people have shared.