Setup Guide — From Install to AI-Ready
Go from installing flexx to having AI agents reach your machine in under two minutes. flexx setup authenticates and registers the machine; flexx connect (or flexx service install) brings it online.
The golden path
Run these on the machine you want to reach:
flexx setup
flexx connect # or: flexx service installflexx setup handles authentication and registration only. It does not start the daemon. After setup, start a connection with one of:
| Command | When to use |
|---|---|
flexx service install | Always-on (recommended) — starts on login |
flexx connect | Foreground session (blocks the terminal) |
flexx connect --daemon | Background process without a system service |
What flexx setup does
- Authenticate — browser login or API key from the dashboard
- Register — registers this machine as a remote
- MCP config — prints the JSON to paste into your AI agent
Example output
Welcome to flexx.dev
✓ Already authenticated
Registering this machine as "dev-laptop"...
✓ Remote registered (ID: a7f3c2e1)
MCP Configuration:
{
"mcpServers": {
"flexx": {
"url": "https://relay.flexx.dev/v1/mcp",
"headers": {
"Authorization": "Bearer flexx_…"
}
}
}
}
Next steps
flexx service install # always-on (recommended)
flexx connect # foreground session
flexx connect --daemon # background processSetup alone does not put the machine online
Until you run flexx connect (or install the service), the machine is registered
but offline, and only Memory tools are available to your AI client. Remote
tools — files, shell, screenshots, tunnels — appear once it is connected.
Step-by-step (manual)
If you prefer to run each step separately:
1. Authenticate
flexx auth loginGet your API key from Dashboard → Settings → API Keys.
2. Register this machine
flexx remote initThis registers your machine with the flexx API and saves the remote configuration to ~/.flexx/remote.json.
3. Start the daemon
flexx connectOr run in the background:
flexx connect --daemonOr install as a user service (starts on login):
flexx service install4. Configure your AI agent
flexx mcp configThis prints the MCP JSON block. Paste it into your AI tool:
- Cursor — Settings → MCP → Add Server → paste the URL
- Claude Desktop — add to
~/.claude/mcp_servers.json - ChatGPT — add as an MCP server endpoint
- Any MCP client — use
https://relay.flexx.dev/v1/mcp
Or visit the dashboard for copy-paste configs tailored to each AI tool. Full details in MCP configuration.
Install as a system service
For the daemon to start automatically on login:
flexx service installThis creates:
- Linux — a systemd user unit
- macOS — a LaunchAgent
- Windows — a Task Scheduler task (user-level, no admin required)
Uninstall with flexx service uninstall. See System Service.
Next steps
- MCP configuration — connect Cursor, Claude, ChatGPT, or any client
- Memory — persistent context for your agents (no install needed)
- Bring your own models — power Flexx Agent with your own provider keys
- SSH access —
ssh flexx-<name>into the machine
Install flexx CLI
Install the flexx CLI on macOS, Linux, or Windows with one command. This is the step that makes a machine reachable from anywhere — Memory works without it.
CLI Reference
Complete reference for all flexx CLI commands. Install, authenticate, connect, and manage remotes from the terminal.