GitLab Docs

https://docs.gitlab.com
Admin
GitLab's comprehensive documentation covers its features for managing code, CI/CD, security,...
Tokens:17,620,357
Snippets:142,139
Trust Score:10
Update:4 days ago
Show doc for...
Tokens:
Raw
### glab skills install examples

Source: https://docs.gitlab.com/cli/skills/install

Examples covering the default core skill install, installing a specific bundled skill by name, global user-scope install, custom directory install, and overwriting an existing skill file.

```console
# Install the core glab skill in the current project (default)
glab skills install

# Install a specific bundled skill by name
glab skills install glab-stack

# Install the core skill globally (user scope)
glab skills install --global

# Install a skill to a custom directory
glab skills install glab-stack --path /path/to/skills

# Overwrite an existing skill file
glab skills install --force

```

--------------------------------

### GDK Setup Commands

Source: https://docs.gitlab.com/development/data_seeder

Commands to start the database, install gems, and run migrations in a GDK environment.

```shell
$ gdk start db
ok: run: services/postgresql: (pid n) 0s, normally down
ok: run: services/redis: (pid n) 74s, normally down
$ bundle install
Bundle complete!
$ bundle exec rake db:migrate
main: migrated
ci: migrated
```

--------------------------------

### glab govern setup examples

Source: https://docs.gitlab.com/cli/govern/setup/index.md

Examples of configuring hooks and fallback sync, configuring only hooks, syncing Codex and Cursor sessions, and uninstalling.

```console
# Configure hooks and the fallback periodic sync
$ glab govern setup

# Configure only the hooks
$ glab govern setup --no-fallback-sync

# Also sync Codex and Cursor sessions through the fallback periodic sync
$ glab govern setup --agents codex,cursor

# Remove the hooks and the fallback periodic sync
$ glab govern setup --uninstall
```

--------------------------------

### Example .gitlab-ci.yml for hosted runners on Windows

Source: https://docs.gitlab.com/ci/runners/hosted_runners/windows

Use this example to get started with hosted runners on Windows. It defines a reusable .windows_job template with before_script commands and two jobs (build and test) that extend it.

```yaml
.windows_job:
  tags:
    - saas-windows-medium-amd64
  before_script:
    - Set-Variable -Name "time" -Value (date -Format "%H:%m")
    - echo ${time}
    - echo "started by ${GITLAB_USER_NAME} / @${GITLAB_USER_LOGIN}"

build:
  extends:
    - .windows_job
  stage: build
  script:
    - echo "running scripts in the build job"

test:
  extends:
    - .windows_job
  stage: test
  script:
    - echo "running scripts in the test job"
```

--------------------------------

### Run Xcode first launch setup

Source: https://docs.gitlab.com/runner/configuration/macos_setup/index.md

Agree to the license and install recommended Xcode components via the command line.

```shell
sudo xcodebuild -runFirstLaunch
```

--------------------------------

### glab opentofu init examples

Source: https://docs.gitlab.com/cli/opentofu/init/index.md

Examples of initializing state with different options: default binary, directory, Terraform binary, and reconfiguring state.

```console
# Initialize state with name production in working directory
glab opentofu init production

# Initialize state with name production in infra/ directory
glab opentofu init production -d infra/

# Initialize state with name production with Terraform
glab opentofu init production -b terraform

# Initialize state with name production with reconfiguring state
glab opentofu init production -- -reconfigure
```

--------------------------------

### Examples of glab duo cli usage

Source: https://docs.gitlab.com/cli/duo/cli/index.md

Provides common usage examples: starting an interactive session, running headless with a goal, passing through commands and flags, showing help, skipping prompts, installing, and updating.

```console
# Start an interactive GitLab Duo CLI session
glab duo cli

# Use the GitLab Duo CLI in headless mode with a single prompt
glab duo cli run --goal "Fix the failing tests in this project"

# Pass any command or flag through to the GitLab Duo CLI binary (for example: model, version, run)
glab duo cli <command>
glab duo cli --model claude_sonnet_4_6

# Show GitLab CLI help content
glab duo cli --help

# Show GitLab Duo CLI help content, including commands and flags
glab duo cli help

# Run without prompts (for use in scripts and non-interactive environments)
glab duo cli --yes

# Install the GitLab Duo CLI binary
glab duo cli --install

# Install the GitLab Duo CLI binary without prompts
glab duo cli --install --yes

# Check for and install updates
glab duo cli update
```

--------------------------------

### Example devfile configuration with postStart events

Source: https://docs.gitlab.com/user/workspace

A complete devfile example defining two containers and four exec commands, with postStart events referencing all four commands. The container image is for demonstration purposes only.

```yaml
schemaVersion: 2.2.0
variables:
  registry-root: registry.gitlab.com
components:
  - name: tooling-container
    attributes:
      gl/inject-editor: true
    container:
      image: "{{registry-root}}/gitlab-org/remote-development/gitlab-remote-development-docs/ubuntu:22.04"
      env:
        - name: KEY
          value: VALUE
      endpoints:
        - name: http-3000
          targetPort: 3000
  - name: database-container
    attributes:
      overrideCommand: false
    container:
      image: mysql
      command: ["echo"]
      args: ["-n", "user-defined entrypoint command"]
      env:
        - name: MYSQL_ROOT_PASSWORD
          value: "my-secret-pw"
commands:
  # Command 1: Container 1, no working directory (uses project directory)
  - id: install-dependencies
    exec:
      component: tooling-container
      commandLine: "npm install"

  # Command 2: Container 1, with working directory
  - id: setup-environment
    exec:
      component: tooling-container
      commandLine: "echo 'Setting up development environment'"
      workingDir: "/home/gitlab-workspaces"

  # Command 3: Container 2, no working directory (uses container default)
  - id: init-database
    exec:
      component: database-container
      commandLine: "echo 'Database initialized' > db-init.log"

  # Command 4: Container 2, with working directory
  - id: setup-database
    exec:
      component: database-container
      commandLine: "mkdir -p /var/lib/mysql/logs && echo 'DB setup complete' > setup.log"
      workingDir: "/var/lib/mysql"

events:
  postStart:
    - install-dependencies
    - setup-environment
    - init-database
    - setup-database
```

--------------------------------

### Example response for GET /job

Source: https://docs.gitlab.com/api/jobs/index.md

Example JSON response returned by the GET /job endpoint.

```json
{
  "commit": {
    "author_email": "admin@example.com",
    "author_name": "Administrator",
    "created_at": "2015-12-24T16:51:14.000+01:00",
    "id": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
    "message": "Test the CI integration.",
    "short_id": "0ff3ae19",
    "title": "Test the CI integration."
  },
  "coverage": null,
  "archived": false,
  "source": "push",
  "allow_failure": false,
  "created_at": "2015-12-24T15:51:21.880Z",
  "started_at": "2015-12-24T17:54:30.733Z",
  "finished_at": "2015-12-24T17:54:31.198Z",
  "erased_at": null,
  "duration": 0.465,
  "queued_duration": 0.123,
  "artifacts_expire_at": "2016-01-23T17:54:31.198Z",
  "id": 8,
  "name": "rubocop",
  "pipeline": {
    "id": 6,
    "project_id": 1,
    "ref": "main",
    "sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
    "status": "pending"
  },
  "ref": "main",
  "artifacts": [],
  "runner": null,
  "runner_manager": null,
  "stage": "test",
  "status": "failed",
  "failure_reason": "script_failure",
  "tag": false,
  "web_url": "https://example.com/foo/bar/-/jobs/8",
  "project": {
    "ci_job_token_scope_enabled": false
  },
  "user": {
    "id": 1,
    "name": "Administrator",
    "username": "root",
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
    "web_url": "http://gitlab.dev/root",
    "created_at": "2015-12-21T13:14:24.077Z",
    "bio": null,
    "location": null,
    "public_email": "",
    "linkedin": "",
    "twitter": "",
    "website_url": "",
    "organization": ""
  }
}
```

--------------------------------

### Run development setup with make development_setup

Source: https://docs.gitlab.com/runner/development/index.md

Run this after installing the required binaries (VirtualBox, Vagrant, kubectl, minikube, Parallels, PowerShell) to set up the development environment. Tests requiring missing binaries are skipped.

```shell
make development_setup
```

--------------------------------

### glab deploy-key add examples

Source: https://docs.gitlab.com/cli/deploy-key/add

Examples showing how to add a deploy key from stdin, from a key file, and with the can-push attribute.

```console
# Read deploy key from stdin and upload.
glab deploy-key add -t "my title"

# Read deploy key from specified key file and upload
cat ~/.ssh/id_ed25519.pub | glab deploy-key add --title='test' -

# Read deploy key from specified key file, upload and set "can push" attribute.
glab deploy-key add ~/.ssh/id_ed25519.pub -t "my title" --can-push true

```

--------------------------------

### Install and start Jenkins using Homebrew

Source: https://docs.gitlab.com/development/integrations/jenkins/index.md

Installs Jenkins on macOS and starts the Jenkins background service.

```shell
brew install jenkins
brew services start jenkins
```

--------------------------------

### Legacy GitOps agent configuration with manifest_projects

Source: https://docs.gitlab.com/user/clusters/agent/gitops/migrate_to_flux

Example legacy GitOps agent configuration that defines a manifest project and a glob path for manifests. Use this as a starting point to understand the legacy setup before migrating to Flux.

```yaml
gitops:
  manifest_projects:
  - id: <your-group>/<your-repository>
    paths:
    - glob: 'manifests/*.yaml'
```

--------------------------------

### Install and start GitLab Runner and rbenv

Source: https://docs.gitlab.com/runner/configuration/macos_setup/index.md

Install rbenv and GitLab Runner using Homebrew and start the GitLab Runner service.

```shell
brew install rbenv gitlab-runner
brew services start gitlab-runner
```

--------------------------------

### glab repo create examples

Source: https://docs.gitlab.com/cli/repo/create

Examples of creating repositories under an account, group, specific name, group path, or a different host.

```console
# Create a repository under your account using the current directory name.
glab repo create

# Create a repository under a group using the current directory name.
glab repo create --group glab-cli

# Create a repository with a specific name.
glab repo create my-project

# Create a repository for a group.
glab repo create glab-cli/my-project

# Create on a host other than gitlab.com.
GITLAB_HOST=example.com glab repo create
glab repo create <host>/path/to/repository
```

--------------------------------

### Get a single group label example response

Source: https://docs.gitlab.com/api/group_labels

Example JSON response returned by the GET /groups/:id/labels/:label_id endpoint.

```json
{
  "id": 7,
  "name": "bug",
  "color": "#FF0000",
  "text_color" : "#FFFFFF",
  "description": null,
  "description_html": null,
  "open_issues_count": 0,
  "closed_issues_count": 0,
  "open_merge_requests_count": 0,
  "subscribed": false,
  "archived": false
}
```

--------------------------------

### Create helloworld.go sample file

Source: https://docs.gitlab.com/tutorials/scan_execution_policy/index.md

Add this basic Go program to the initial project repository to serve as the application codebase for scan execution policy testing.

```go
package main
import "fmt"
func main() {
    fmt.Println("Hello world")
}
```

--------------------------------

### Example: Install a package with Chocolatey CLI

Source: https://docs.gitlab.com/user/packages/nuget_repository

Example commands to install a package named MyPackage from a source named gitlab or from a URL with credentials.

```shell
choco install MyPackage -Source gitlab -Version 1.0.2

# or

choco install MyPackage -Source "https://gitlab.example.com/api/v4/projects/<project_id>/packages/nuget/v2" -u <username> -p <personal_access_token> -Version 1.0.2
```

--------------------------------

### Install libraries and run migrations

Source: https://docs.gitlab.com/update/patch_versions/index.md

Configure Bundler, install and clean gems, execute database migrations, and compile assets while clearing cache.

```shell
cd /home/git/gitlab

# If you haven't done so during installation or a previous upgrade already
sudo -u git -H bundle config set --local deployment 'true'
sudo -u git -H bundle config set --local without 'development test kerberos'

# Update gems
sudo -u git -H bundle install

# Optional: clean up old gems
sudo -u git -H bundle clean

# Run database migrations
sudo -u git -H bundle exec rake db:migrate RAILS_ENV=production

# Clean up assets and cache
sudo -u git -H bundle exec rake yarn:install gitlab:assets:clean gitlab:assets:compile cache:clear RAILS_ENV=production NODE_ENV=production NODE_OPTIONS="--max_old_space_size=4096"
```

--------------------------------

### Start the Rails console for Omnibus or source installations

Source: https://docs.gitlab.com/administration/wikis

Use this command to start the Rails console before configuring wiki settings. Choose the Omnibus command for Omnibus installations or the source command for installations from source.

```shell
# For Omnibus installations
sudo gitlab-rails console

# For installations from source
sudo -u git -H bundle exec rails console -e production
```

--------------------------------

### Examples for uploading deploy keys

Source: https://docs.gitlab.com/cli/deploy-key/add/index.md

Uploads a deploy key from stdin or a key file, with an option to enable write/push permissions.

```console
# Read deploy key from stdin and upload.
glab deploy-key add -t "my title"

# Read deploy key from specified key file and upload
cat ~/.ssh/id_ed25519.pub | glab deploy-key add --title='test' -

# Read deploy key from specified key file, upload and set "can push" attribute.
glab deploy-key add ~/.ssh/id_ed25519.pub -t "my title" --can-push true
```

--------------------------------

### glab securefile get examples

Source: https://docs.gitlab.com/cli/securefile/get

Provides example usages: getting details by ID, using the 'show' alias, and targeting another project with -R.

```console
# Get details of a secure file by ID
glab securefile get 1

# Get details using the 'show' alias
glab securefile show 1

# Get details from another project
glab securefile get 1 -R owner/repo

```

--------------------------------

### Clone and set up the release tools repository

Source: https://docs.gitlab.com/charts/development/release

First step of the manual release process: clone the release-tools repository and install its dependencies with bundle install.

```shell
git clone git@gitlab.com:gitlab-org/release-tools.git
bundle install
```

--------------------------------

### Get details on a Support PIN - Example request

Source: https://docs.gitlab.com/api/users

Example curl request to get Support PIN details using a personal access token.

```shell
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/user/support_pin"
```

--------------------------------

### Create a Kind cluster with an example configuration

Source: https://docs.gitlab.com/charts/development/kind

Spin up a Kind cluster using one of the example configurations in doc/examples/kind. Review and adjust the configuration as needed before running.

```shell
kind create cluster --config examples/kind/kind-ssl.yaml
```

--------------------------------

### Get merge base response example

Source: https://docs.gitlab.com/api/repositories

Example JSON response from the Get merge base endpoint, showing the common ancestor commit details.

```json
{
  "id": "1a0b36b3cdad1d2ee32457c102a8c0b7056fa863",
  "short_id": "1a0b36b3",
  "title": "Initial commit",
  "created_at": "2014-02-27T08:03:18.000Z",
  "parent_ids": [],
  "message": "Initial commit\n",
  "author_name": "Example User",
  "author_email": "user@example.com",
  "authored_date": "2014-02-27T08:03:18.000Z",
  "committer_name": "Example User",
  "committer_email": "user@example.com",
  "committed_date": "2014-02-27T08:03:18.000Z",
  "trailers": {},
  "extended_trailers": {},
  "web_url": "https://gitlab.example.com/example-group/example-project/-/commit/1a0b36b3cdad1d2ee32457c102a8c0b7056fa863"
}
```

--------------------------------

### Get commit sequence example response

Source: https://docs.gitlab.com/api/commits

Example JSON response for the get commit sequence endpoint, returning the `count` sequence number of the commit.

```json
{
  "count": 632
}
```

--------------------------------

### Create ci/docker_install.sh for build environment setup

Source: https://docs.gitlab.com/ci/examples/php

Create this script in the root directory to install prerequisites before testing. It installs git, PHPUnit, and the MySQL driver.

```shell
#!/bin/bash

# You need to install dependencies only for Docker
[[ ! -e /.dockerenv ]] && exit 0

set -xe

# Install git (the php image doesn't have it) which is required by composer
apt-get update -yqq
apt-get install git -yqq

# Install phpunit, the tool that you will use for testing
curl --location --output /usr/local/bin/phpunit "https://phar.phpunit.de/phpunit.phar"
chmod +x /usr/local/bin/phpunit

# Install mysql driver
# Here you can install any other extension that you need
docker-php-ext-install pdo_mysql
```

--------------------------------

### glab repo search examples

Source: https://docs.gitlab.com/cli/repo/search

Examples showing how to search for projects using the search flag with different command aliases.

```console
glab project search -s "title"
glab repo search -s "title"
glab project find -s "title"
glab project lookup -s "title"
```
Tokens:
Raw