GitLab Integration

Use OpenCode in GitLab issues and merge requests through CI/CD pipeline or GitLab Duo.

OpenCode integrates with your GitLab workflow through your GitLab CI/CD pipeline or with GitLab Duo.

In both cases, OpenCode will run on your GitLab runners.

GitLab CI

OpenCode works in a regular GitLab pipeline. You can build it into a pipeline as a CI component.

Here we are using a community-created CI/CD component for OpenCode — nagyv/gitlab-opencode.

Features

• Use custom configuration per job: Configure OpenCode with a custom configuration directory, for example ./config/#custom-directory to enable or disable functionality per OpenCode invocation.
• Minimal setup: The CI component sets up OpenCode in the background, you only need to create the OpenCode configuration and the initial prompt.
• Flexible: The CI component supports several inputs for customizing its behavior.

Setup

1. Store authentication credentials

   Store your OpenCode authentication JSON as a File type CI environment variable under Settings > CI/CD > Variables. Make sure to mark them as “Masked and hidden”.

2. Add to .gitlab-ci.yml

   Add the following to your .gitlab-ci.yml file:

   .gitlab-ci.yml

   include:
     - component: $CI_SERVER_FQDN/nagyv/gitlab-opencode/opencode@2
       inputs:
         config_dir: ${CI_PROJECT_DIR}/opencode-config
         auth_json: $OPENCODE_AUTH_JSON # The variable name for your OpenCode authentication JSON
         command: optional-custom-command
         message: "Your prompt here"
   

For more inputs and use cases check out the docs for this component.

GitLab Duo

OpenCode integrates with your GitLab workflow through GitLab Duo. Mention @opencode in a comment, and OpenCode will execute tasks within your GitLab CI pipeline.

Features

• Triage issues: Ask OpenCode to look into an issue and explain it to you.
• Fix and implement: Ask OpenCode to fix an issue or implement a feature. It will create a new branch and raise a merge request with the changes.
• Secure: OpenCode runs on your GitLab runners.

Setup

OpenCode runs in your GitLab CI/CD pipeline, here’s what you’ll need to set it up:

Check out the GitLab docs for up to date instructions.

1. Configure your GitLab environment

   Set up your GitLab environment to support agent assistants.

2. Set up CI/CD

   Configure your GitLab CI/CD pipeline with the necessary jobs.

3. Get an AI model provider API key

   Obtain an API key from your AI model provider (e.g., Anthropic).

4. Create a service account

   Create a GitLab service account with appropriate permissions.

5. Configure CI/CD variables

   Store your API keys and tokens as CI/CD variables in your GitLab project settings.

6. Create a flow config file

   Create a flow configuration file for OpenCode. Here’s an example:

   Flow configuration example

   image: node:22-slim
   commands:
     - echo "Installing opencode"
     - npm install --global opencode-ai
     - echo "Installing glab"
     - export GITLAB_TOKEN=$GITLAB_TOKEN_OPENCODE
     - apt-get update --quiet && apt-get install --yes curl wget gpg git && rm --recursive --force /var/lib/apt/lists/*
     - curl --silent --show-error --location "https://raw.githubusercontent.com/upciti/wakemeops/main/assets/install_repository" | bash
     - apt-get install --yes glab
     - echo "Configuring glab"
     - echo $GITLAB_HOST
     - echo "Creating OpenCode auth configuration"
     - mkdir --parents ~/.local/share/opencode
     - |
       cat > ~/.local/share/opencode/auth.json << EOF
       {
         "anthropic": {
           "type": "api",
           "key": "$ANTHROPIC_API_KEY"
         }
       }
       EOF
     - echo "Configuring git"
     - git config --global user.email "[e-mail]"
     - git config --global user.name "OpenCode"
     - echo "Testing glab"
     - glab issue list
     - echo "Running OpenCode"
     - |
       opencode run "
       You are an AI assistant helping with GitLab operations.
   
       Context: $AI_FLOW_CONTEXT
       Task: $AI_FLOW_INPUT
       Event: $AI_FLOW_EVENT
   
       Please execute the requested task using the available GitLab tools.
       Be thorough in your analysis and provide clear explanations.
   
       <important>
       Please use the glab CLI to access data from GitLab. The glab CLI has already been authenticated. You can run the corresponding commands.
   
       If you are asked to summarize an MR or issue or asked to provide more information then please post back a note to the MR/Issue so that the user can see it.
       You don't need to commit or push up changes, those will be done automatically based on the file changes you make.
       </important>
       "
     - git checkout --branch $CI_WORKLOAD_REF origin/$CI_WORKLOAD_REF
     - echo "Checking for git changes and pushing if any exist"
     - |
       if ! git diff --quiet || ! git diff --cached --quiet || [ --not --zero "$(git ls-files --others --exclude-standard)" ]; then
         echo "Git changes detected, adding and pushing..."
         git add .
         if git diff --cached --quiet; then
           echo "No staged changes to commit"
         else
           echo "Committing changes to branch: $CI_WORKLOAD_REF"
           git commit --message "Codex changes"
           echo "Pushing changes up to $CI_WORKLOAD_REF"
           git push https://gitlab-ci-token:$GITLAB_TOKEN@$GITLAB_HOST/gl-demo-ultimate-dev-ai-epic-17570/test-java-project.git $CI_WORKLOAD_REF
           echo "Changes successfully pushed"
         fi
       else
         echo "No git changes detected, skipping push"
       fi
   variables:
     - ANTHROPIC_API_KEY
     - GITLAB_TOKEN_OPENCODE
     - GITLAB_HOST
   

You can refer to the GitLab CLI agents docs for detailed instructions.

Usage Examples

Here are some examples of how you can use OpenCode in GitLab.

You can configure to use a different trigger phrase than @opencode.

Explain an Issue

Add this comment in a GitLab issue:

@opencode explain this issue

OpenCode will read the issue and reply with a clear explanation.

Fix an Issue

In a GitLab issue, say:

@opencode fix this

OpenCode will create a new branch, implement the changes, and open a merge request with the changes.

Review Merge Requests

Leave the following comment on a GitLab merge request:

@opencode review this merge request

OpenCode will review the merge request and provide feedback.

FAQ

Can I use OpenCode with GitLab.com?

Yes, OpenCode works with both GitLab.com and self-hosted GitLab instances.

Do I need GitLab Duo to use OpenCode?

No, you can use OpenCode through the GitLab CI component without GitLab Duo. However, GitLab Duo provides a more integrated experience with @opencode mentions.

Can OpenCode work with private repositories?

Yes, OpenCode works with both public and private repositories on GitLab.

How do I customize the trigger phrase?

You can customize the trigger phrase in your flow configuration file. Change @opencode to any other trigger phrase you prefer.

What permissions does the service account need?

The service account needs permissions to read repository content, create branches, create merge requests, and comment on issues and merge requests.