Quickstart

Use this quickstart to get from a new Upsun Dispatch account to your first code review run. You will create an organization, store an Anthropic or OpenAI model key, connect GitHub or GitLab, open a test pull request or merge request, and watch Upsun Dispatch publish review results.

​

Before you begin

You need:

• Access to the Upsun Dispatch console.
• An Anthropic or OpenAI API key.
• A GitHub repository where you can install or link the Upsun Dispatch GitHub App, or a GitLab project that you can connect with the required project and service-account credentials.

For detailed setup options, see Set up GitHub, Set up GitLab, and AI models.

​

1. Sign in

1. Open the Upsun Dispatch console.
2. Select Sign in.
3. Complete the Upsun sign-in flow.

After sign-in, Upsun Dispatch creates a browser session and shows the organizations you can access.

​

2. Create an organization

If you do not already have an organization:

1. Go to the organizations page in the Upsun Dispatch console.
2. Create an organization and enter a label for it.
3. Open the new organization.

The user who creates an organization becomes its owner. You can manage organization members, invitations, repositories, runs, usage, and settings from the Upsun Dispatch console.

​

3. Store a model key

Upsun Dispatch uses organization-scoped model keys for workflow runs.

1. In your organization, go to Settings > AI model keys.
2. Select your model integration: Anthropic or OpenAI.
3. Select Add key.
4. Paste the API key.
5. Select Save.
6. If your organization stores more than one model key, choose the default model integration for organization runs.

After a key is stored, Upsun Dispatch only shows key metadata, such as the last four characters and set or tested timestamps. The full key value is not shown again. To change keys later, remove or replace the stored key from the same settings area. For details, see AI models, Store your Anthropic key, or Store your OpenAI key.

​

4. Connect a source integration

Choose one integration for your first run.

​

5. Open a test pull request or merge request

Create a small change in a connected repository and open a pull request or merge request. If the Code review workflow is set to automatic triggering, Upsun Dispatch starts a review when it receives a supported event:

• For GitHub, open or push to a pull request in a connected repository.
• For GitLab, open or update a merge request in a connected project.

If your organization has set review triggering to manual, request a review with a comment command instead:

• On GitHub, comment @upsun-dispatch review on the pull request.
• On GitLab, comment @<configured-bot-username> review on the merge request.

For more about automatic reviews, manual commands, full reviews, review limits, summaries, and GitHub or GitLab review output, see Code review.

​

6. Watch the run

1. In Upsun Dispatch, open your organization.
2. Go to Runs.
3. Open the newest run for your test pull request or merge request.

The run detail page shows the run status, duration, step statuses, timeline events, prompts, findings, artifacts, opened pull requests, push outcomes, log activity, and usage information. Active runs can stream live job logs. Completed runs keep recorded job log activity for later review. GitHub and GitLab also show progress and results:

• GitHub reviews use check runs and review comments.
• GitLab reviews use progress notes, commit statuses, and merge request notes.

​

7. Adjust workflow settings

After your first run, tune Code review behavior for the organization or for individual repositories. In Settings > Workflows, you can configure supported workflow settings, such as trigger mode, ignored authors, summary mode, GitLab fork-author admission, plan approval, model integration selection, and repository-specific overrides. For the canonical settings overview, see Workflows in Upsun Dispatch. For Code review behavior, including summary behavior, see Code review. For console tasks such as browsing repositories, filtering runs, rerunning eligible runs, and viewing usage, see Use the Upsun Dispatch console.

​

Next steps