Quick Start
FlightDesk adds the team workflow around Claude Code: shared task visibility, preview environments, and QA handoff. This guide gets you from zero to your first task.
What You'll Need
- A GitHub account with at least one repository
- Claude Code installed and working on your machine
- Node.js 18+ (for the CLI)
Step 1: Create Your Account
Go to flightdesk.dev/register and sign up with your email or GitHub account. Email verification is required before you can log in.
Once verified, you'll land inside your organization dashboard.
Step 2: Connect GitHub
FlightDesk uses a GitHub App for secure, short-lived access to your repositories.
- Go to Settings → Organization → Integrations
- On the GitHub card, click Connect
- Authorize the FlightDesk app on GitHub
- Select which repositories to grant access to
FlightDesk will immediately start receiving PR webhooks from those repositories. No manual webhook setup required.
Step 3: Create a Project
Projects link a GitHub repository to FlightDesk.
- Go to Projects → New Project
- Select your connected GitHub repository
- Give the project a name
- Save
Optionally configure preview environments at this step — you can always do it later in project settings.
Step 4: Create an API Token
The CLI and the API both authenticate with a personal API token.
- Go to Settings → Personal → API Tokens
- Click Create Token, give it a name like "MacBook Pro CLI"
- Copy the token — it is shown once
The same page shows the Claude Desktop MCP configuration, if you want an AI assistant reading your FlightDesk data as well. See MCP Setup.
Step 5: Install and Configure the CLI
The CLI connects your terminal to FlightDesk. The package is called flightdesk:
npm install -g flightdesk
Then point it at your account and paste the token when prompted:
flightdesk init
Confirm it worked:
flightdesk whoami
That prints the user the token resolves to, the active organization, and where it read the credential from. Configuration lives in ~/.flightdeskrc.
Step 6: Create Your First Task
- Go to Tasks → New Task
- Select your project
- Write a title and a description of the work
- Click Create Task
Or from the terminal:
flightdesk task create -p <project-id> -t "Fix the login redirect loop"
Step 7: How the Work Moves
Every task moves through the same phases:
Backlog → Ready → Plan → Plan review → Build → Waiting → QA → Merge → (Release) → Done
What varies is where a person is needed, set per project under Project Settings → Orchestration:
- Plan review — a person approves the plan before Build, or a finished plan goes straight to it
- QA — a person checks the work on the preview before Merge, or green CI is enough
- Releases — staged (merged work waits at Release until someone ships it) or continuous (every merge is its own release, and merged means Done)
And whether FlightDesk drives the work at all. With orchestration on, FlightDesk dispatches an agent at each step and owns the phase. With it off, the phase follows the pull request and QA — open the task, watch the branch, the PR, the checks and the preview URL land on it, and move it yourself.
If you build the work locally, hand the pull request over and let the pipeline take it from there:
flightdesk task handoff --pr 412
Next Steps
- Task Workflow — the phases in full, and how run status relates to them
- Pipeline and Gates — gates, roles, question routing and task flags
- Agents and Orchestration — letting FlightDesk dispatch the work
- Set up Preview Environments for live PR previews
- Built-in Prompts to review pull requests and create QA test plans
- Notifications — what FlightDesk emails you, and when
- Connect SonarQube for supporting code quality feedback