Skip to content
FlightStack Docs

Quick Start

Quick Start Guide

Section titled “Quick Start Guide”

Get your first Flutter app building and deploying in minutes. This guide walks you through the essential steps to get FlightStack running.

Prerequisites

Section titled “Prerequisites”

Before you begin, make sure you have:

  • A Flutter app in a GitHub repository
  • A Mac, Linux, or Windows machine for running builds
  • The FlightStack CLI installed

Setup Steps

Section titled “Setup Steps”

  1. Install the CLI

    Section titled “Install the CLI”
    Terminal window
    # Using Homebrew
    brew tap voostack/tap
    brew install flightstack
    

    # Or download directly
    curl -fsSL https://get.flightstack.dev | bash

  2. Log In

    Section titled “Log In”

    Authenticate with your FlightStack account:

    Terminal window
    flightstack login

    This opens a browser window to complete authentication. Once done, you’ll see:

    ✓ Logged in successfully!
    

    Welcome back, your-username

  3. Register a Build Agent

    Section titled “Register a Build Agent”

    Register your machine as a build agent:

    Terminal window
    flightstack agent register

    The CLI will detect your system capabilities:

    System Information:
      Platform: macOS
      OS Version: macOS 14.0
      Xcode: 15.0
      Flutter: 3.16.0
      Dart: 3.2.0
    

    Capabilities:
      iOS: ✓
      Android: ✓
      Web: ✓
    

    ✓ Agent registered successfully!
    Agent ID: abc123-def456-...

  4. Start the Agent

    Section titled “Start the Agent”

    Start the agent to begin accepting builds:

    Terminal window
    flightstack agent start

    Or install it to start automatically on boot:

    Terminal window
    flightstack agent install

    You should see:

    FlightStack Build Agent
    ────────────────────────────────────
    Agent: My-MacBook-Pro
    API: https://api.flightstack.dev
    

    ✓ Agent is online
    

    Waiting for builds... (Ctrl+C to stop)

  5. Create Your First Pipeline

    Section titled “Create Your First Pipeline”

    Open the FlightStack app and:

    1. Navigate to Repositories
    2. Click Connect Repository and select your GitHub repo
    3. Go to the Pipelines tab
    4. Click Create Pipeline

    In the visual editor:

    • Drag a Trigger (e.g., “On Push”) to the canvas
    • Drag a Build iOS job and connect it to the trigger
    • Drag a Notification job to get notified when done
    • Click Save

  6. Push Some Code

    Section titled “Push Some Code”

    Push a commit to trigger your first build:

    Terminal window
    git commit --allow-empty -m "Trigger first FlightStack build"
    git push

    Watch your build run in the FlightStack app! 🎉

What’s Next?

Section titled “What’s Next?”

Now that you have a basic pipeline running, explore these topics:

Add Deployment

Section titled “Add Deployment”

Set up automatic deployment to app stores:

Configure Code Signing

Section titled “Configure Code Signing”

Learn how to set up automatic code signing:

Optimize Your Pipeline

Section titled “Optimize Your Pipeline”

Make your builds faster and more reliable:

Run Agent on Boot

Section titled “Run Agent on Boot”

Set up your agent to start automatically:

Terminal window
flightstack agent install

See Auto-Start on Boot for details.

Troubleshooting

Section titled “Troubleshooting”

Agent not connecting?

Section titled “Agent not connecting?”
  1. Check your internet connection
  2. Verify you’re logged in: flightstack login
  3. Check agent status: flightstack agent status

Build failing?

Section titled “Build failing?”
  1. Check the build logs in the FlightStack app
  2. Ensure Flutter is installed: flutter doctor
  3. Verify Xcode is set up (for iOS): xcode-select -p

Need help?

Section titled “Need help?”