Skip to content

Install the agent ​

The LivePane agent is a single binary named livepane. It runs on each machine you want to connect, completes claim pairing, heartbeats to the server, and streams terminal panes.

Config after claim: ~/.livepane/agent.json
(If you previously used AgentCtrl, the agent one-shot migrates ~/.agentctrl/agent.json into that path.)

There is no Finder / DMG installer in this product phase. Use one of the paths below.

Choose an install path ​

MethodWhen to use
HomebrewPreferred public install (tap + formula URLs → livepane-agent)
Install scriptPublic one-liner from livepane-agent release assets
From sourceLocal development against a monorepo clone

Use one install path per machine so upgrades stay simple.

Ship status today: agent release assets on original-solutions/livepane-agent are public (anonymous tarball download). Residual: the monorepo original-solutions/livepane may remain private — do not use monorepo raw.githubusercontent.com URLs for install.

Homebrew ​

bash
brew tap original-solutions/livepane
brew trust original-solutions/livepane
brew install original-solutions/livepane/agent
livepane version

Upgrade later with brew upgrade agent (do not run livepane update over a Homebrew-managed binary). Prefer the product supervisor (livepane install-service) over stacking brew services on the same host — two KeepAlive supervisors will fight.

Anonymous brew installs download release tarballs from the public original-solutions/livepane-agent repo (not the main monorepo). Formula lives in the public tap original-solutions/homebrew-livepane as Formula/agent.rb (install path original-solutions/livepane/agent; binary remains livepane). If brew install fails, use the install script or build from source below.

Install script ​

Public one-liner (no monorepo access, no token):

bash
curl -fsSL https://github.com/original-solutions/livepane-agent/releases/latest/download/install-agent.sh | bash

Defaults install to ~/.local/bin/livepane — keep that directory on your PATH.

Pin a version or install the OS supervisor in the same step:

bash
curl -fsSL https://github.com/original-solutions/livepane-agent/releases/latest/download/install-agent.sh \
  | VERSION=v0.2.0 bash -s -- --install-service

Supported platforms for this script: darwin/amd64, darwin/arm64, linux/amd64, linux/arm64.

From a monorepo clone (maintainers):

bash
bash scripts/install-agent.sh

From source ​

bash
cd packages/agent
go build -o "$HOME/.local/bin/livepane" ./cmd/livepane
livepane version

After install ​

  1. Claim the machine (pairs agent ↔ workspace):

    bash
    livepane claim --server https://YOUR_SERVER

    The agent prints a claim code. Confirm that code in the LivePane web app as a workspace owner (see Claim a machine).

  2. Keep the agent running so the machine shows online:

    bash
    livepane run
    # or register the product supervisor (macOS launchd / Linux systemd user / Windows service):
    livepane install-service
    # remove later with:
    # livepane uninstall-service

That is the full end-user path: install → claim → run. Next: Claim a machine.

Security: run the agent under a dedicated non-root OS user and treat create-grant members as trusted operators on that host. See Agent residual risk & least privilege.

Upgrades ​

How you installedHow to upgrade
Install script / release tarball / custom BIN_DIRlivepane update (self-replaces this binary from GitHub Releases)
Homebrewbrew upgrade livepane only
From sourceRebuild and replace the binary, or use livepane update if you installed a release build

Optional: set "auto_update": true in ~/.livepane/agent.json so livepane run may apply a newer release at most once per day. Leave it off unless you want unattended upgrades.