Skip to content

Before you start

Mate is a GitLab-native agent orchestrator: you assign an issue, ask for a review or @-mention a managed account, and Mate spawns an LLM-driven agent that reads the context, acts in GitLab (comments, branches, MRs, issue updates, depending on the permissions you grant), and reports back — all from a dedicated GitLab account you control.

Mate is currently in closed beta. Once the beta’s workspace cap is reached, new workspaces are held on a waitlist and admitted manually. If you do not have an invitation, sign in at platform.mate.engineer and try to create a workspace; you will be placed in the first-come, first-served queue.

Before you begin, have the following ready:

  • A GitLab project where you can manage webhooks (Maintainer or Owner). The webhook is added at the project or group level.

  • A dedicated GitLab account for Mate. This account acts as Mate in GitLab: every comment, branch, and MR the agent creates appears to come from it. Do not use your personal account. Add it as a member of each project Mate should work in, with a role that fits what you plan to grant (Reporter to comment, Developer to push branches and open MRs, Maintainer for merge or touch_ci).

  • A Personal Access Token (PAT) for that account with the api scope. You will paste it into Mate; Mate encrypts it and you cannot retrieve it later.

  • A GitLab instance Mate can reach. On the hosted service, GitLab must be reachable from the internet: URLs that resolve to loopback or private addresses are rejected.

  • An LLM API key. Mate is BYOK (bring your own key). Claude subscription (OAuth) tokens are not supported; use an API key. Supported key providers:

    • OpenRouter — access to many models through one key.
    • Anthropic direct — if you have a direct Anthropic account.
    • OpenAI-compatible — OpenAI, or any provider with an OpenAI-compatible API (for example Mistral), with an optional https:// base URL.

    The key works with one or more of the four agent CLIs: Claude Code, Codex, OpenCode and omp. See Models and BYOK.

After you create a workspace, the console home page shows a Set up your workspace checklist with six items. You can complete them in any order; nothing blocks the rest of the console. This walkthrough covers them in a sensible order:

  1. Before you start (this page)
  2. Sign in and create a workspace
  3. Connect GitLab — the GitLab URL and the managed account
  4. LLM credentials
  5. Create your first agent — an agent and trigger from the Teammate template
  6. Register a webhook
  7. Run your first job

The sixth checklist item, Subscribe, is done under Settings → Billing (Owner only; see Pricing). Billing is per mate, that is per concurrent job slot, and the workspace needs a subscription before Mate runs any job.

Next: Sign in and create a workspace