Getting Started
NFLTR is a hosted orchestration service at nfltr.xyz. This guide walks you from account creation through your first nfltr orch start worker smoke test—no servers to provision, no repo to clone.
1. Create your account
Open nfltr.xyz/dashboard and sign up with email or SSO. After sign-in you land on the orchestration home view: fleet readiness, recent runs, and API key management. Keep this tab open—you will paste an API key into the CLI in step 3.
From Settings → API keys, create a key scoped to your user. Copy it once; the dashboard shows a redacted value afterward. Treat keys like passwords—never commit them to git.
2. Install the nfltr CLI
Install the latest CLI for macOS or Linux. Pick whichever path matches your machine:
- Homebrew (macOS) — when your team publishes a tap:
brew install nfltr - Direct download — from nfltr.xyz/dashboard, download the binary for your OS/architecture, move it onto your
PATH, and mark it executable.
Confirm the install prints a version string:
$ nfltr version3. Save your API key locally
Store the key from the dashboard so every nfltr orch subcommand authenticates to the hosted control plane:
$ nfltr config add-api-key rpc_your_key_hereOptional: label a teammate’s key for switching contexts without re-pasting secrets:
$ nfltr config add-api-key rpc_teammate_key --name aliceList and switch keys with nfltr config list-api-keys and nfltr config use-api-key. You can also export NFLTR_API_KEY in CI, but local development is smoother with the config store.
4. Connect a worker (your machine)
Workers are long-lived CLI processes that advertise labels and capacity to nfltr.xyz. On the laptop that should execute tasks, start a worker with labels your planner will target:
$ nfltr worker --labels role=implementer,pool=devLeave the process running. Within a few seconds the dashboard Fleet view should show the worker as ready with matching labels. If it stays offline, jump to Troubleshooting before dispatching work.
5. Smoke test: dispatch one task
With a worker ready, dispatch a small objective from your terminal. Replace WORKER_ID with the id shown in Fleet:
$ nfltr orch start worker --worker WORKER_ID --role implementer --objective "Reply with a one-line JSON result confirming connectivity" --watchThe --watch flag tails lifecycle events until the task reaches a terminal state. A successful run ends with structured JSON where status is result or verification.
$ nfltr orch spec decompose --goal "Summarize README changes in three bullets"Authentication, task storage, and worker routing all live on nfltr.xyz. Your CLI is a thin client; deleting local config does not delete cloud tasks.
6. Confirm in the dashboard
Open nfltr.xyz/dashboard, locate the orchestration card for your smoke test, and click the worker node. You should see state transitions, the objective text, and the result summary.