Skip to main content

Getting started — install Farmslot

Install with one command
curl -fsSL https://raw.githubusercontent.com/deeeed/farmslot/main/install.sh | bash

Copy, paste, done — prerequisites are checked (never auto-installed), a workspace lands in ~/farmslot/, and the run ends with a green farmslot doctor. Early preview: main moves daily, run farmslot update often.

Two commands take a fresh machine to working farm slots; one keeps it current.

For a visual walk-through of the full lifecycle (what runs, what lands where, what you customize, and how to remove it), see onboarding-flow.md.

Install​

curl -fsSL https://raw.githubusercontent.com/deeeed/farmslot/main/install.sh | bash

From inside a checkout (dev/test mode), bash install.sh uses the checkout as the source instead of cloning from a URL.

What it does:

  • checks prerequisites (git, node per engines, yarn, tmux, python3) and agent runners (at least one of claude / codex / cursor-agent / grok). On macOS it can install missing common tools through Homebrew prompts (FARMSLOT_AUTO_INSTALL=1 accepts those prompts non-interactively); otherwise it prints fix hints and stops.
  • activates existing asdf/nvm installs in non-interactive shells and uses them to install/switch to the repo's recommended Node version when needed.
  • on macOS, checks for the standalone capture-helper package and can install it with Homebrew or npm install -g @siteed/capture-helper unless FARMSLOT_SKIP_CAPTURE_HELPER=1 is set. The installer doctors the package's native binary when available (CAPTURE_HELPER_PATH / SITEED_CAPTURE_HELPER_BIN can override it), avoiding wrapper shims for capture paths. Grant Screen Recording permission to the terminal app on first capture so Command Center can show live visual evidence. The legacy embedded helper under tools/capture-helper/ has been removed.
  • creates the workspace (default ~/farmslot, override with FARMSLOT_WORKSPACE): farmslot/ clone, repos/, runs/, state.json
  • installs dependencies, builds the CLI's workspace packages, symlinks farmslot into FARMSLOT_BIN_DIR (default ~/.local/bin)
  • generates pool/<hostname>.json (zero slots, ports from 9300+). If the source checkout already owns that file, writes <hostname>-onboard.json instead — existing pool files are never overwritten
  • ends with farmslot doctor

Re-running repairs/updates; it never duplicates.

Pair the mobile companion​

Install ends with an optional Pair your phone step unless FARMSLOT_MINIMAL is set. It starts the local gateway and runs:

farmslot pair

The QR includes every reachable local LAN address. If Tailscale is installed, signed in, and MagicDNS is available on the Mac, it also includes a ws://<machine>.<tailnet>.ts.net:<port>/ws profile. Scan it from Companion Settings → Pair from QR. For away-from-LAN use, sign the phone into the same Tailnet before scanning; otherwise the LAN profile is still enough while the phone and Mac are on the same network. Tailnet profiles use ws:// because Tailscale encrypts traffic at the WireGuard layer; only scan them on devices that are signed into the expected tailnet.

If Tailscale was not available during install, pair over LAN first and rerun farmslot pair after installing/signing into Tailscale on both devices.

Add a project pack​

farmslot project add <path-or-git-url>

Registers the pack's projects, blobless-clones product repos into <workspace>/repos/, creates and validates the declared slots, runs the pack's smoke check, prints the pack's action sheet, and finishes with doctor. See project packs for the pack contract.

Re-running with the same source is a no-op (verify only); a changed source repairs in place. Slots are never duplicated.

Stay current​

farmslot update
  • hard-updates the workspace clone to latest main (the clone is a tool, not a workspace — local edits are stashed with a warning first); dev/test installs re-sync from the source checkout's branch instead
  • reinstalls dependencies and rebuilds the CLI packages
  • applies versioned pool migrations (migrations/pool/) to this workspace's machine pool file — new defaults are added, user edits preserved, applied steps recorded in state.json
  • re-runs the sync hook of any registered pack whose content hash changed
  • ends with doctor

Note: the update engine itself runs from the pre-update code — when an update changes farmslot update's own logic, run it twice to pick the new engine up.

Remove it​

farmslot uninstall

Removes this installation at its recorded locations (reads state.json, so a custom FARMSLOT_WORKSPACE/BIN_DIR/HOME is handled): the framework clone, product-repo clones, state.json, and the farmslot PATH symlink. Run history (<workspace>/runs/) and the home dir (gateway auth/profiles) default to keep — each is an interactive keep / back-up / delete choice.

  • --dry-run — print the plan, remove nothing
  • --yes — non-interactive; keeps history + home unless --purge
  • --purge — also delete history + home/credentials
  • --backup-history <path> / --backup-home <path> — archive before removing

Only a farmslot symlink that resolves into this workspace is removed; a foreign one on your PATH is left untouched.

Manage multiple gateways​

The CLI targets any number of gateways through named profiles (ADR-036), stored machine-level in ~/.farmslot/gateways.json (0600 — secrets never appear in command output):

farmslot gateway add lab wss://lab-host:7777   # first profile becomes active
farmslot login lab --token <token>      # or --password <p> / --code <pairing-code>
farmslot auth status --all              # authenticated / not signed in / unreachable per profile
farmslot fleet status --gateway lab     # any command can target a profile
farmslot gateway use lab                # set the default for future commands
farmslot logout lab                     # forget the stored credential

Resolution order per invocation: --url > --gateway <name> > GW_URL env > active profile > ws://localhost:7777. login verifies against the gateway's existing auth.connect / pairing flow before storing anything; a wrong credential is never persisted. Prefer --code (pairing) on shared machines — --token/--password values land in shell history. Local single-gateway use needs no profiles at all.

Check health anytime​

farmslot doctor

Green checklist (prereqs, runners, workspace, pool, packs, CLI, gateway profiles) or specific failures with fix hints. Exit code reflects status.

Fast pack registration​

For heavyweight packs, prefer a registration-only first pass:

farmslot project add <pack> --no-setup

This proves the workspace, pack contract, slot registration, repo clones, and fixtures without running product builds. Follow with a focused full setup when ready:

farmslot project add <pack> --project <project-name>