Getting started

Onboarding

This setup guide will walk you through the initial set up for Runbooks. If you plan to use the self-hosted option, please contact [email protected].

1. Create an account: https://app.aviator.co/auth/login

2. Follow the onboarding flow to connect to the Aviator GitHub app, authorize one or more repositories that you want to use with Runbooks. You can always add more repositories later.

If you have trouble connecting the app, please read the troubleshooting doc.

Workflow

Aviator Agents workflow is divided into 3 phases:

• Planning

• Execution

• Review

Planning

This is the phase where you work with the agents to plan out a work.

1. Once a repository is connected, go to the Runbooks dashboard: https://app.aviator.co/runbooks/new

2. On the chat prompt, describe briefly the task that you want to collaborate with the agents on, and select the repository to start with.

Start a new plan

1. This will create a new chat session, where the agents will build a Runbook after analyzing the code. Building the Runbook is a multistep process. During this process, the agents will:

   1. Fetch the code from GitHub

   2. Inspect the query

   3. Analyze the code base to build the context

   4. Understand dependencies

   5. Ask clarifying questions

2. You can provide feedback via the chat interface or modify the Runbook manually. Runbooks follow a specific pattern and the agents will validate it on every edit.

Execution

1. Runbooks are typically executed step by step. You can execute the next step by simply clicking "Execute Next" button on the steps view.

2. This will trigger internally trigger Claude code in the background. You should be able to view all the activity logs in the chat dashboard. Once the step is completed, agents will create one or more PRs and share the links within the corresponding Runbook step.

3. If you choose to execute all steps, you can click the dropdown and select "Execute all". This will enqueue all steps that will run sequentially creating stacked PRs.

Review

1. For any PRs generated by the agents, you can review the changes directly in GitHub similar to how you review a PR created by a developer.

2. After a review is submitted, the agents will analyze all the comments and make corresponding edits.

3. You can go back and forth with the agents requesting multiple iterations to improve the code. Once you are satisfied with the changes, you can merge the PR manually or using MergeQueue.