Skip to content

Getting started

Linux or WSL with systemd user services. You do not clone the repo.

If you only remember one thing

Download the release, run picode install, open https://localhost:8445. Clone the repo only when you are changing PiCode.

Windows: PiCode Desktop. A machine you reach from elsewhere: On a server.

1. Install Pi and tmux

PiCode runs real Pi agents. Install Pi and tmux 3.5+ on this machine:

bash
npm install -g @earendil-works/pi-coding-agent

Use your distro's tmux package if it is 3.5 or newer.

2. Install PiCode

bash
V=$(curl -fsSL https://api.github.com/repos/cfpperche/picode/releases/latest | sed -n 's/.*"tag_name": *"v\{0,1\}\([^"]*\)".*/\1/p')
curl -fLO https://github.com/cfpperche/picode/releases/download/v$V/picode-linux-amd64
curl -fLO https://github.com/cfpperche/picode/releases/download/v$V/SHA256SUMS
sha256sum -c --ignore-missing SHA256SUMS
chmod +x picode-linux-amd64
./picode-linux-amd64 install

install copies the binary to ~/.local/bin/picode, writes the systemd user unit, and starts it. Put ~/.local/bin on your PATH if picode is not found after this.

3. Create an agent

Open https://localhost:8445. The sidebar has a tab per kind: Agents (agents without a project), Workspaces (your project folders — each card holds its agents and terminals, and its buttons create them right there), Terminals (loose shells) and Pins. Add a workspace, add an agent inside it (or a free agent), then click Run. Close the browser tab; the agent keeps running.

The desktop shell: workspaces and agents in the sidebar, what needs you first, and today's numbers on the right

Video: creating an agent from the browser — the screens above are the real app.

The first visit may warn about the certificate. picode provision installs a locally trusted one when mkcert is present (it may ask for root once).

After that

CommandWhat it does
picode updateDownload and verify a newer GitHub release, then restart
picode uninstallRemove the service; --purge also deletes ~/.picode
picode pairPrint a one-time link for another browser or phone

Phone: On your phone. Send the tab you are looking at to an agent: Chrome extension. Changing PiCode itself: From source.

Personal use is free under PolyForm Noncommercial. Company use needs a commercial license.