RepoBird Logo

Getting Started with Repobird.ai

1. Connect GitHub

The first and most crucial step is to install the RepoBird GitHub App on the repositories you want RepoBird to work with. This allows RepoBird to receive notifications about new issues and comments, and to post responses back.

Optional: Add RepoBirdBot for Autocompletion While not required for RepoBird to function (it uses the App installation's permissions), you can optionally add the RepoBirdBot user as a collaborator to your repositories (read access is sufficient). Doing so enables helpful autocompletion suggestions when you start typing @RepobirdBot commands in GitHub issue or pull request comments. You can invite the bot here: https://github.com/RepoBirdBot.

GitHub Integration

How to install the GitHub app on your repository:

  1. First,create an account with Repobird for easier integration
  2. Install the Github App at: https://github.com/apps/repobird
  3. Select whether to install on your personal account or an organization
  4. Choose repository access (all repositories or select specific ones).
  5. Review the requested permissions and click "Install".
  6. The bot user @RepoBirdBot should be automatically added as a collaborator. If not, please add it manually.
  7. After installation, automatic redirect for GitHub integration should occur. If you lose that URL you can uninstall/reinstall or follow the Manual Connection directions below.

Already installed the app? Connect your Repobird account:

If you've already installed the GitHub app, use the button below to connect your Repobird account to that installation ID:

Connect GitHub Installation

Your installation ID will be automatically captured via our OAuth callback route.

Manual Connection

Find your installation ID manually:

If the automatic connection doesn't work, you can manually find your installation ID:

  1. Go to your repository settings:https://github.com/YOUR_USERNAME/YOUR_REPO/settings
  2. In the left sidebar, click on "Integrations" section
  3. Click "GitHub Apps" and then "Configure" next to the Repobird App
  4. Check the URL in your browser - it will look like:https://github.com/organizations/YOUR_ORG/settings/installations/12345678
  5. The number at the end (e.g.,12345678) is your installation ID
  6. Enter this number in the connection form when prompted

2. Triggering a RepoBird Agent Run

Interacting with RepoBird involves triggering an AI agent run. You can do this by mentioning the bot handler in a comment on either a GitHub **Issue** or a **Pull Request**.

The default bot handler is @RepobirdBot.

Available Commands:

  • @RepobirdBot help (or just @RepobirdBot)
    Shows the help message detailing available commands and usage for the current context (Issue or Pull Request). Mentioning the bot without a command defaults to showing help.
  • @RepobirdBot basic [options] [instructions...]
    Triggers a 'basic' agent run using the standard AI model.
    • On Issues: You can optionally specify source:<branch> and target:<branch>. Any text after the command and options is added as instructions to the prompt.
    • On Pull Requests: Branch options are not allowed. You must provide instructions after the command (e.g., @RepobirdBot basic Please refactor this function.).
  • @RepobirdBot pro [options] [instructions...]
    Triggers a 'pro' agent run using the advanced AI model.
    • On Issues: You can optionally specify source:<branch> and target:<branch>. Any text after the command and options is added as instructions to the prompt.
    • On Pull Requests: Branch options are not allowed. You must provide instructions after the command (e.g., @RepobirdBot pro Implement the requested changes.).

Prompt Context: When you trigger a run from a comment, the AI agent's prompt is constructed from:

  • The original Issue or Pull Request title.
  • The original Issue or Pull Request body.
  • Any additional text you provide in the triggering comment *after* the command itself (your specific instructions).

RepoBird will acknowledge the request in the comment thread and begin the agent run, posting status updates and eventually the results (often a new Pull Request) back to the original Issue or PR.

The AI agent does its best to research and find relevant code, files, and shell scripts by itself. However, adding context like specific file paths, code snippets, or relevant commands directly into the issue/PR body or your command comment will definitely help it run quicker and more accurately.

Pro Tip: Clearly mention in the issue body or command comment whether the bot should attempt to run tests or scripts (e.g., "Run `npm test` after changes"). You can also state constraints like "Do not install any new dependencies" or conditions for completion, such as "Do not mark any task as done until all tests pass successfully". This provides strong guidance for the bot's actions.

3. Basic vs. Pro Runs

RepoBird offers different types of processing runs, typically tied to your subscription tier. These affect the AI model used, the complexity of tasks that can be handled, and execution priority.

Pro Runs

Utilize more advanced and powerful AI models. They are better suited for complex coding tasks, detailed analysis, or generating higher-quality code. Pro runs often have higher priority in the processing queue. You might trigger these explicitly (e.g., @RepobirdBot pro) or they may be the default for higher subscription tiers.

Basic Runs

Use more cost-effective AI models, suitable for simpler tasks, quick fixes, or basic questions. These are typically available on free or lower-cost tiers and may have lower processing priority compared to Pro runs. They provide a great way to get started and handle routine automation.

Note: All issue runs, regardless of type, have a maximum execution time of 45 minutes.

Time Limit Behavior: If a run reaches the 45-minute limit, RepoBird will stop processing but will still attempt to create a Pull Request containing all the code changes made up to that point.

Check your subscription details or the Pricing page for specifics on run limits and features available in your tier.