Skip to content

quickstart.mdx

Latest commit

 

History

History
128 lines (86 loc) · 3.08 KB

quickstart.mdx

File metadata and controls

128 lines (86 loc) · 3.08 KB
Raw
title Quickstart
description Install your first fleet and send it a GitHub event.
type tutorial
audience user
verified 2026-07-12
product_version 0.26.2
executable false

Quickstart

What you will build

You will install a GitHub pull request reviewer fleet. The fleet will receive pull request events and post review comments.

Before you begin

You need Node.js 24 or later. You also need an agentsfleet account and a GitHub repository that you can manage.

Create a GitHub token that can read the repository and post comments. Keep the token ready for step 4.

Steps

  1. Install the agentsfleet command-line interface.

    npm install --global @agentsfleet/cli
    added <varies> packages in <varies>

  2. Check the installed version.

    agentsfleet --version
    <varies>

  3. Sign in through your browser.

    agentsfleet login
    Login session
session_id: <varies>
login_url: <varies>
browser: opened
login complete

    Approve the request in your browser. Enter the six-digit code in your terminal when prompted.

  4. Save the GitHub secret in your active workspace.

    agentsfleet secret create github --data='{"token":"<GITHUB_TOKEN>","webhook_secret":"<GITHUB_WEBHOOK_SECRET>"}'
    ✓ Secret 'github' stored in vault.

    GitHub gives you <GITHUB_TOKEN> after you create the repository token.

    Create <GITHUB_WEBHOOK_SECRET> as a random value with at least 32 characters. Enter the same value in GitHub during step 6.

    The client sends both values to your workspace vault. The client does not print the values again.

  5. Install the review fleet.

    agentsfleet install --library github-pr-reviewer
    ✓ github-pr-reviewer is live.
  Fleet ID: <varies>
  Webhook URLs (register on the upstream provider):
    github: <varies>

    Save the fleet identifier and webhook URL from this output. You will use both values below.

  6. Add the webhook in GitHub.

    Open Repository settings → Webhooks → Add webhook. Use the webhook URL from step 5 as the payload URL.

    Choose application/json as the content type. Use the same webhook secret from step 4.

    Select Pull requests as the event. GitHub now sends pull request events to your fleet.

  7. Open a pull request in the repository.

    GitHub sends the event after you open the pull request. The fleet then posts a review comment.

Verify it works

<FLEET_ID> comes from the install output in step 5.

agentsfleet logs <FLEET_ID>
Event Stream
  <varies>  webhook:github  <varies>

The activity stream should show a GitHub event. Check the pull request for the fleet's review comment.

What you learned

You installed the client, signed in, saved a secret, and created a fleet. You also connected GitHub to the fleet.

Related pages