Free makes a remote machine available to an ACP-capable editor as if it were a local ACP agent. It owns the product surface around the relay Worker, native ACP bridge, machine host, account authorization, and remote operational tooling.
@saaskit-dev/acp-runtime remains the local SDK dependency. Free should import
only the public runtime API from that package; relay, bridge, host, daemon, and
Worker behavior belong in this repository.
Install the latest CLI from source:
curl -fsSL https://raw.githubusercontent.com/saaskit-dev/Free/main/scripts/install.sh | bashThe installer clones Free and acp-runtime, builds the required local packages,
packs Free, installs the resulting CLI globally with npm, then runs
free auth login by default.
Useful install flags:
--no-logininstalls only thefreeCLI.--no-hostlogs in without installing the default user host.--systeminstalls the macOS host as a boot-time system service after login.--force-loginrefreshes browser login and reinstalls the active host mode.--relay-url <ws-url>uses a non-default relay.--ref <git-ref>installs a specific Free branch, tag, or commit.
For a local checkout:
./scripts/install.shThe installed package exposes free:
free auth login
free auth status
free auth logout
free host install
free host status
free host restart
free host run
free bridge run
free bridge configThe normal user flow is:
- Run
free auth loginon each machine that should host agents. - Keep
free host runor the installed host service running on those machines. - Configure the editor ACP client to launch
free bridge run.
Hosts are registered in the relay control plane. Offline hosts can still appear in discovery using their last known metadata, but only currently connected hosts are selectable for a new route.
The user-facing path is:
Editor ACP client -> free bridge run -> Relay Worker -> free host run -> acp-runtime -> Agent
The relay control plane stores account, client, host, grant, session binding, and last-known host metadata in D1. Relay memory is limited to live transport state such as active WebSocket routes, heartbeats, reconnect windows, pending frames, and in-flight waiters.
See docs/remote-acp.md and docs/relay-invariants.md for the detailed relay
and trust-boundary rules.
Use the maintained make targets:
make help
make install
make build
make test
make verifyCommon relay commands:
make relay-dev
make relay-deploy-dry-run
make relay-migrate-remote
make relay-deploy
make remote-prod-smokemake build builds the local ../acp-runtime dependency and then Free.
make verify runs typecheck, tests, package creation, install smoke, and relay
deploy dry-run.