[{"data":1,"prerenderedAt":796},["ShallowReactive",2],{"/en-us/blog/reduce-the-load-on-gitlab-gitaly-with-bundle-uri":3,"navigation-en-us":34,"banner-en-us":444,"footer-en-us":454,"blog-post-authors-en-us-Olivier Campeau":694,"blog-related-posts-en-us-reduce-the-load-on-gitlab-gitaly-with-bundle-uri":708,"assessment-promotions-en-us":747,"next-steps-en-us":786},{"id":4,"title":5,"authorSlugs":6,"body":8,"categorySlug":9,"config":10,"content":14,"description":8,"extension":25,"isFeatured":11,"meta":26,"navigation":27,"path":28,"publishedDate":18,"seo":29,"stem":30,"tagSlugs":31,"__hash__":33},"blogPosts/en-us/blog/reduce-the-load-on-gitlab-gitaly-with-bundle-uri.yml","Reduce The Load On Gitlab Gitaly With Bundle Uri",[7],"olivier-campeau",null,"product",{"featured":11,"template":12,"slug":13},false,"BlogPost","reduce-the-load-on-gitlab-gitaly-with-bundle-uri",{"title":15,"description":16,"heroImage":17,"date":18,"body":19,"category":9,"tags":20,"authors":23},"Reduce the load on GitLab Gitaly with bundle URI","Discover what the bundle URI Git feature is, how it is integrated into Gitaly, configuration best practices, and how GitLab users can benefit from it.","https://res.cloudinary.com/about-gitlab-com/image/upload/v1750099013/Blog/Hero%20Images/Blog/Hero%20Images/blog-image-template-1800x945%20%2814%29_6VTUA8mUhOZNDaRVNPeKwl_1750099012960.png","2025-06-24","Gitaly plays a vital role in the GitLab ecosystem — it is the server component that handles all Git operations. Every push and pull made to/from a repository is handled by Gitaly, which has direct access to the disk where the actual repositories are stored. As a result, when Gitaly is under heavy load, some operations like CI/CD pipelines and browsing a repository in the\nGitLab UI can become quite slow. This is particularly true when serving clones and fetches for large and busy monorepos, which can consume large amounts of CPU and memory.\n\n[Bundle URI](https://docs.gitlab.com/administration/gitaly/bundle_uris/) takes significant load off of Gitaly servers during clones by allowing Git to pre-download a bundled repository from object storage before calling the Gitaly servers to fetch the remaining objects.\n\nHere is a graph that shows the difference between clones without and with bundle URI.\n\n![Graph that shows the difference between clones without and with bundle URI](https://res.cloudinary.com/about-gitlab-com/image/upload/v1750705069/rvbm4ru1w58msd6zv4x7.png)\n\nThis graph shows the results of a small test we ran on an isolated GitLab installation, with Gitaly running on a machine with 2 CPUs. We wanted to test bundle URI with a large repository, so we pushed the [GitLab repository](https://gitlab.com/gitlab-org/gitlab) to the instance. We also generated a bundle beforehand.\n\nThe big CPU spike is from when we performed a single clone of the GitLab repository with bundle URI disabled. It's quite noticeable. A little later, we turned on bundle URI and launched three concurrent clones of the GitLab repository. Sure enough, turning on bundle URI provides massive performance gain. We can't even distinguish the CPU usage of the three clones from normal usage.\n\n## Configure Gitaly to use bundle URI\n\nTo enable bundle URI on your GitLab installation, there are a couple of things you need to configure.\n\n### Create a cloud bucket\n\nBundles need to be stored somewhere. The ideal place is in a cloud storage bucket. Gitaly uses the [gocloud.dev](https://pkg.go.dev/gocloud.dev) library to read and write from cloud storage. Any cloud storage solution supported by this library can be used. Once you have a cloud bucket URL, you can add it in the Gitaly configuration here:\n\n```toml\n[bundle_uri]\ngo_cloud_url = \"\u003Cbucket-uri>\"\n```\n\nIt must be noted that Gitaly does not manage the lifecycle of the bundles stored in the bucket. To avoid cost issues, object lifecycle policies must be enabled on the bucket in order to delete unused or old objects.\n\n### Enable the feature flags\n\nThere are two feature flags to enable:\n\n- `gitaly_bundle_generation` enables [auto-generation](#auto-generated) of bundles.\n\n- `gitaly_bundle_uri` makes Gitaly advertise bundle URIs when they are available (either manually created or auto-generated) and allows the user to [manually](#manual) generate bundles.\n\nThese feature flags can be enabled at-large on a GitLab installation, or per repository. See the [documentation on how to enable a GitLab feature behind a feature flag](https://docs.gitlab.com/administration/feature_flags/#how-to-enable-and-disable-features-behind-flags).\n\n### How to generate bundles\n\nGitaly offers two ways for users to use bundle URI: a [manual](#manual) way and an [auto-generated](#auto-generated) way.\n\n#### Manual\n\nIt is possible to create a bundle manually by connecting over SSH with the Gitaly node that stores the repository you want to create a bundle for, and run the following command:\n\n```shell\nsudo -u git -- /opt/gitlab/embedded/bin/gitaly bundle-uri \n--config=\u003Cconfig-file>\n--storage=\u003Cstorage-name>\n--repository=\u003Crelative-path>\n```\n\nThis command will create a bundle for the given repository and store it into the bucket configured above. When a subsequent `git clone` request will reach Gitaly for the same repository, the bundle URI mechanism described above will come into play.\n\n#### Auto-generated\n\nGitaly can also generate bundles automatically, using a heuristic to determine if it is currently handling frequent clones for the same repository.\n\nThe current heuristic keeps track of the number of times a `git fetch` request is issued for each repository. If the number of requests reaches a certain `threshold` in a given time `interval`, a bundle is automatically generated. Gitaly also keeps track of the last time it generated a bundle for a repository. When a new bundle should be regenerated, based on the `threshold` and `interval`, Gitaly looks at the last time a bundle was generated for the given repository. It will only generate a new bundle if the existing bundle is older than some `maxBundleAge` configuration. The old bundle is overwritten. There can only be one bundle per repository in cloud storage.\n\n## Using bundle URI\n\nWhen a bundle exists for a repository, it can be used by the `git clone` command.\n\n### Cloning from your terminal\n\nTo clone a repository from your terminal, make sure your Git configuration enables bundle URI. The configuration can be set like so:\n\n```shell\ngit config --global transfer.bundleuri true\n```\n\nTo verify that bundle URI is used during a clone, you can run the `git clone` command with `GIT_TRACE=1` and see if your bundle is being downloaded:\n```shell\n➜  GIT_TRACE=1 git clone https://gitlab.com/gitlab-org/gitaly\n...\n14:31:42.374912 run-command.c:667       trace: run_command: git-remote-https '\u003Cbundle-uri>'\n...\n```\n\n### Cloning during CI/CD pipelines\n\nOne scenario where using bundle URI would be beneficial is during a CI/CD pipeline, where each job needs a copy of the repository in order to run. Cloning a repository during a CI/CD pipeline is the same as cloning a repository from your terminal, except that the Git client in this case is the GitLab Runner. Thus, we need to configure the GitLab Runner in such a way that it can use bundle URI.\n\n**1. Update the helper-image**\n\nThe first thing to do to configure the GitLab Runner is to [overwrite the helper-image](https://docs.gitlab.com/runner/configuration/advanced-configuration/#override-the-helper-image) that your GitLab Runner instances use. The `helper-image` is the image that is used to run the process of cloning a repository before the job starts. To use bundle URI, the image needs the following:\n\n- Git Version 2.49.0 or later\n\n- [`GitLab Runner helper`](https://gitlab.com/gitlab-org/gitlab-runner/-/tree/main/apps/gitlab-runner-helper?ref_type=heads) Version 18.1.0 or later\n\nThe helper-images can be found [here](https://gitlab.com/gitlab-org/gitlab-runner/container_registry/1472754?orderBy=PUBLISHED_AT&sort=desc&search[]=v18.1.0). Select an image that corresponds to the OS distribution and the architecture you use for your GitLab Runner instances, and verify that the image satisfies the requirements.\n\nAt the time of writing, the `alpine-edge-\u003Carch>-v18.1.0*` tag meets all requirements.\n\nYou can validate the image meets all requirements with:\n\n```shell\ndocker run -it \u003Cimage:tag>\n$ git version ## must be 2.49.0 or newer\n$ gitlab-runner-helper -v ## must be 18.0 or newer\n```\n\nIf you do not find an image that meets the requirements, you can also use the helper-image as a base image and install the requirements yourself in a custom-built image that you can host on [GitLab Container Registry](https://docs.gitlab.com/user/packages/container_registry/).\n\nOnce you have found the image you need, you must configure your GitLab Runner instances to use it by updating your `config.toml` file:\n\n```toml\n[[runners]]\n  (...)\n  executor = \"docker\"\n  [runners.docker]\n    (...)\n    helper_image = \"image:tag\" ## \u003C-- put the image name and tag here\n```\n\nOnce the configuration is changed, you must restart the runners for the new configuration to take effect.\n\n**2. Turn on the feature flag**\n\nNext, you must enable the `FF_USE_GIT_NATIVE_CLONE` [GitLab Runner feature flags](https://docs.gitlab.com/runner/configuration/feature-flags/) in your `.gitlab-ci.yml` file. To do that, simply add it as a variable and set to `true` :\n\n```yaml\nvariables:\n  FF_USE_GIT_NATIVE_CLONE: \"true\"\n```\n\nThe `GIT_STRATEGY` must also be [set to `clone`](\u003Chttps://docs.gitlab.com/ci/runners/configure_runners/#git-strategy>), as Git bundle URI only works with `clone` commands.\n\n## How bundle URI works\n\nWhen a user clones a repository with the `git clone` command, a process called [`git-receive-pack`](https://git-scm.com/docs/git-receive-pack) is launched on the client's machine. This process communicates with the remote repository's server (it can be over HTTP/S, SSH, etc.) and asks to start a [`git-upload-pack`](https://git-scm.com/docs/git-receive-pack) process. Those two processes then exchange information using the Git protocol (it must be noted that bundle URI is only supported with [Git protocol v2](https://git-scm.com/docs/protocol-v2)). The capabilities both processes support and the references and objects the client needs are among the information exchanged. Once the Git server has determined which objects to send to the client, it must package them into a packfile, which, depending on the size of the data it must process, can consume a good amount of resources.\n\nWhere does bundle URI fit into this interaction? If bundle URI is advertised as a capability from the `upload-pack` process and the client supports bundle URI, the Git client will ask the server if it knows about any bundle URIs. The server sends those URIs back and the client downloads those bundles.\n\nHere is a diagram that shows those interactions:\n\n```mermaid\n\nsequenceDiagram\n\n\n    participant receive as Client\n\n\n    participant upload as Server\n\n\n    participant cloud as File server\n\n\n    receive ->> upload: issue git-upload-pack\n\n\n    upload -->> receive: list of server capabilities\n\n\n    opt if bundle URI is advertised as a capability\n\n\n    receive ->> upload: request bundle URI\n\n\n    upload -->> receive: bundle URI\n\n\n    receive ->> cloud: download bundle at URI\n\n\n    cloud -->> receive: bundle file\n\n\n    receive ->> receive: clone from bundle\n\n\n    end\n\n\n    receive ->> upload: requests missing references and objects\n\n\n    upload -->> receive: packfile data\n\n```\n\nAs such, Git [bundle URI](https://git-scm.com/docs/bundle-uri) is a mechanism by which, during a `git clone`, a Git server can advertise the URI of a bundle for the repository being cloned by the Git client. When that is the case, the Git client can clone the repository from the bundle and request from the Git server only the missing references or objects that were not part of the bundle. This mechanism really helps to alleviate pressure from the Git server.\n\n## Alternatives\n\nGitLab also has a feature [Pack-objects cache](https://docs.gitlab.com/administration/gitaly/configure_gitaly/#pack-objects-cache). This feature works slightly differently than bundle URI. When the server packs objects together into a so-called packfile, this feature will keep that file in the cache. When another client needs the same set of objects, it doesn't need to repack them, but it can just send the same packfile again.\n\nThe feature is only beneficial when many clients request the exact same set of objects. In a repository that is quick-changing, this feature might not give any improvements. With bundle URI, it doesn't matter if the bundle is slightly out-of-date because the client can request missing objects after downloading the bundle and apply those changes on top. Also bundle URI in Gitaly stores the bundles on external storage, which the Pack-objects Cache stores them on the Gitaly node, so using the latter doesn't reduce network and I/O load on the Gitaly server.\n\n## Try bundle URI today\n\nYou can try the bundle URI feature in one of the following ways:\n\n* Download a [free trial version of GitLab Ultimate](https://about.gitlab.com/free-trial/).\n\n* If you already run a self-hosted GitLab installation, upgrade to 18.1.\n\n* If you can't upgrade to 18.1 at this time, [download GitLab](https://about.gitlab.com/install/) to a local machine.",[9,21,22],"DevSecOps","git",[24],"Olivier Campeau","yml",{},true,"/en-us/blog/reduce-the-load-on-gitlab-gitaly-with-bundle-uri",{"noIndex":11,"title":15,"description":16},"en-us/blog/reduce-the-load-on-gitlab-gitaly-with-bundle-uri",[9,32,22],"devsecops","Sye6iuEaZzrlqqpyxLRn_87d1aat2Ab6q5g4kLPIB2U",{"data":35},{"logo":36,"freeTrial":41,"sales":46,"login":51,"items":56,"search":364,"minimal":395,"duo":414,"switchNav":423,"pricingDeployment":434},{"config":37},{"href":38,"dataGaName":39,"dataGaLocation":40},"/","gitlab logo","header",{"text":42,"config":43},"Get free trial",{"href":44,"dataGaName":45,"dataGaLocation":40},"https://gitlab.com/-/trial_registrations/new?glm_source=about.gitlab.com&glm_content=default-saas-trial/","free trial",{"text":47,"config":48},"Talk to sales",{"href":49,"dataGaName":50,"dataGaLocation":40},"/sales/","sales",{"text":52,"config":53},"Sign in",{"href":54,"dataGaName":55,"dataGaLocation":40},"https://gitlab.com/users/sign_in/","sign in",[57,84,179,184,285,345],{"text":58,"config":59,"cards":61},"Platform",{"dataNavLevelOne":60},"platform",[62,68,76],{"title":58,"description":63,"link":64},"The intelligent orchestration platform for DevSecOps",{"text":65,"config":66},"Explore our Platform",{"href":67,"dataGaName":60,"dataGaLocation":40},"/platform/",{"title":69,"description":70,"link":71},"GitLab Duo Agent Platform","Agentic AI for the entire software lifecycle",{"text":72,"config":73},"Meet GitLab Duo",{"href":74,"dataGaName":75,"dataGaLocation":40},"/gitlab-duo-agent-platform/","gitlab duo agent platform",{"title":77,"description":78,"link":79},"Why GitLab","See the top reasons enterprises choose GitLab",{"text":80,"config":81},"Learn more",{"href":82,"dataGaName":83,"dataGaLocation":40},"/why-gitlab/","why gitlab",{"text":85,"left":27,"config":86,"link":88,"lists":92,"footer":161},"Product",{"dataNavLevelOne":87},"solutions",{"text":89,"config":90},"View all Solutions",{"href":91,"dataGaName":87,"dataGaLocation":40},"/solutions/",[93,117,140],{"title":94,"description":95,"link":96,"items":101},"Automation","CI/CD and automation to accelerate deployment",{"config":97},{"icon":98,"href":99,"dataGaName":100,"dataGaLocation":40},"AutomatedCodeAlt","/solutions/delivery-automation/","automated software delivery",[102,106,109,113],{"text":103,"config":104},"CI/CD",{"href":105,"dataGaLocation":40,"dataGaName":103},"/solutions/continuous-integration/",{"text":69,"config":107},{"href":74,"dataGaLocation":40,"dataGaName":108},"gitlab duo agent platform - product menu",{"text":110,"config":111},"Source Code Management",{"href":112,"dataGaLocation":40,"dataGaName":110},"/solutions/source-code-management/",{"text":114,"config":115},"Automated Software Delivery",{"href":99,"dataGaLocation":40,"dataGaName":116},"Automated software delivery",{"title":118,"description":119,"link":120,"items":125},"Security","Deliver code faster without compromising security",{"config":121},{"href":122,"dataGaName":123,"dataGaLocation":40,"icon":124},"/solutions/application-security-testing/","security and compliance","ShieldCheckLight",[126,130,135],{"text":127,"config":128},"Application Security Testing",{"href":122,"dataGaName":129,"dataGaLocation":40},"Application security testing",{"text":131,"config":132},"Software Supply Chain Security",{"href":133,"dataGaLocation":40,"dataGaName":134},"/solutions/supply-chain/","Software supply chain security",{"text":136,"config":137},"Software Compliance",{"href":138,"dataGaName":139,"dataGaLocation":40},"/solutions/software-compliance/","software compliance",{"title":141,"link":142,"items":147},"Measurement",{"config":143},{"icon":144,"href":145,"dataGaName":146,"dataGaLocation":40},"DigitalTransformation","/solutions/visibility-measurement/","visibility and measurement",[148,152,156],{"text":149,"config":150},"Visibility & Measurement",{"href":145,"dataGaLocation":40,"dataGaName":151},"Visibility and Measurement",{"text":153,"config":154},"Value Stream Management",{"href":155,"dataGaLocation":40,"dataGaName":153},"/solutions/value-stream-management/",{"text":157,"config":158},"Analytics & Insights",{"href":159,"dataGaLocation":40,"dataGaName":160},"/solutions/analytics-and-insights/","Analytics and insights",{"title":162,"items":163},"GitLab for",[164,169,174],{"text":165,"config":166},"Enterprise",{"href":167,"dataGaLocation":40,"dataGaName":168},"/enterprise/","enterprise",{"text":170,"config":171},"Small Business",{"href":172,"dataGaLocation":40,"dataGaName":173},"/small-business/","small business",{"text":175,"config":176},"Public Sector",{"href":177,"dataGaLocation":40,"dataGaName":178},"/solutions/public-sector/","public sector",{"text":180,"config":181},"Pricing",{"href":182,"dataGaName":183,"dataGaLocation":40,"dataNavLevelOne":183},"/pricing/","pricing",{"text":185,"config":186,"link":188,"lists":192,"feature":272},"Resources",{"dataNavLevelOne":187},"resources",{"text":189,"config":190},"View all resources",{"href":191,"dataGaName":187,"dataGaLocation":40},"/resources/",[193,226,244],{"title":194,"items":195},"Getting started",[196,201,206,211,216,221],{"text":197,"config":198},"Install",{"href":199,"dataGaName":200,"dataGaLocation":40},"/install/","install",{"text":202,"config":203},"Quick start guides",{"href":204,"dataGaName":205,"dataGaLocation":40},"/get-started/","quick setup checklists",{"text":207,"config":208},"Learn",{"href":209,"dataGaLocation":40,"dataGaName":210},"https://university.gitlab.com/","learn",{"text":212,"config":213},"Product documentation",{"href":214,"dataGaName":215,"dataGaLocation":40},"https://docs.gitlab.com/","product documentation",{"text":217,"config":218},"Best practice videos",{"href":219,"dataGaName":220,"dataGaLocation":40},"/getting-started-videos/","best practice videos",{"text":222,"config":223},"Integrations",{"href":224,"dataGaName":225,"dataGaLocation":40},"/integrations/","integrations",{"title":227,"items":228},"Discover",[229,234,239],{"text":230,"config":231},"Customer success stories",{"href":232,"dataGaName":233,"dataGaLocation":40},"/customers/","customer success stories",{"text":235,"config":236},"Blog",{"href":237,"dataGaName":238,"dataGaLocation":40},"/blog/","blog",{"text":240,"config":241},"Remote",{"href":242,"dataGaName":243,"dataGaLocation":40},"https://handbook.gitlab.com/handbook/company/culture/all-remote/","remote",{"title":245,"items":246},"Connect",[247,252,257,262,267],{"text":248,"config":249},"GitLab Services",{"href":250,"dataGaName":251,"dataGaLocation":40},"/services/","services",{"text":253,"config":254},"Community",{"href":255,"dataGaName":256,"dataGaLocation":40},"/community/","community",{"text":258,"config":259},"Forum",{"href":260,"dataGaName":261,"dataGaLocation":40},"https://forum.gitlab.com/","forum",{"text":263,"config":264},"Events",{"href":265,"dataGaName":266,"dataGaLocation":40},"/events/","events",{"text":268,"config":269},"Partners",{"href":270,"dataGaName":271,"dataGaLocation":40},"/partners/","partners",{"backgroundColor":273,"textColor":274,"text":275,"image":276,"link":280},"#2f2a6b","#fff","Insights for the future of software development",{"altText":277,"config":278},"the source promo card",{"src":279},"https://res.cloudinary.com/about-gitlab-com/image/upload/v1758208064/dzl0dbift9xdizyelkk4.svg",{"text":281,"config":282},"Read the latest",{"href":283,"dataGaName":284,"dataGaLocation":40},"/the-source/","the source",{"text":286,"config":287,"lists":289},"Company",{"dataNavLevelOne":288},"company",[290],{"items":291},[292,297,303,305,310,315,320,325,330,335,340],{"text":293,"config":294},"About",{"href":295,"dataGaName":296,"dataGaLocation":40},"/company/","about",{"text":298,"config":299,"footerGa":302},"Jobs",{"href":300,"dataGaName":301,"dataGaLocation":40},"/jobs/","jobs",{"dataGaName":301},{"text":263,"config":304},{"href":265,"dataGaName":266,"dataGaLocation":40},{"text":306,"config":307},"Leadership",{"href":308,"dataGaName":309,"dataGaLocation":40},"/company/team/e-group/","leadership",{"text":311,"config":312},"Team",{"href":313,"dataGaName":314,"dataGaLocation":40},"/company/team/","team",{"text":316,"config":317},"Handbook",{"href":318,"dataGaName":319,"dataGaLocation":40},"https://handbook.gitlab.com/","handbook",{"text":321,"config":322},"Investor relations",{"href":323,"dataGaName":324,"dataGaLocation":40},"https://ir.gitlab.com/","investor relations",{"text":326,"config":327},"Trust Center",{"href":328,"dataGaName":329,"dataGaLocation":40},"/security/","trust center",{"text":331,"config":332},"AI Transparency Center",{"href":333,"dataGaName":334,"dataGaLocation":40},"/ai-transparency-center/","ai transparency center",{"text":336,"config":337},"Newsletter",{"href":338,"dataGaName":339,"dataGaLocation":40},"/company/contact/#contact-forms","newsletter",{"text":341,"config":342},"Press",{"href":343,"dataGaName":344,"dataGaLocation":40},"/press/","press",{"text":346,"config":347,"lists":348},"Contact us",{"dataNavLevelOne":288},[349],{"items":350},[351,354,359],{"text":47,"config":352},{"href":49,"dataGaName":353,"dataGaLocation":40},"talk to sales",{"text":355,"config":356},"Support portal",{"href":357,"dataGaName":358,"dataGaLocation":40},"https://support.gitlab.com","support portal",{"text":360,"config":361},"Customer portal",{"href":362,"dataGaName":363,"dataGaLocation":40},"https://customers.gitlab.com/customers/sign_in/","customer portal",{"close":365,"login":366,"suggestions":373},"Close",{"text":367,"link":368},"To search repositories and projects, login to",{"text":369,"config":370},"gitlab.com",{"href":54,"dataGaName":371,"dataGaLocation":372},"search login","search",{"text":374,"default":375},"Suggestions",[376,378,382,384,388,392],{"text":69,"config":377},{"href":74,"dataGaName":69,"dataGaLocation":372},{"text":379,"config":380},"Code Suggestions (AI)",{"href":381,"dataGaName":379,"dataGaLocation":372},"/solutions/code-suggestions/",{"text":103,"config":383},{"href":105,"dataGaName":103,"dataGaLocation":372},{"text":385,"config":386},"GitLab on AWS",{"href":387,"dataGaName":385,"dataGaLocation":372},"/partners/technology-partners/aws/",{"text":389,"config":390},"GitLab on Google Cloud",{"href":391,"dataGaName":389,"dataGaLocation":372},"/partners/technology-partners/google-cloud-platform/",{"text":393,"config":394},"Why GitLab?",{"href":82,"dataGaName":393,"dataGaLocation":372},{"freeTrial":396,"mobileIcon":401,"desktopIcon":406,"secondaryButton":409},{"text":397,"config":398},"Start free trial",{"href":399,"dataGaName":45,"dataGaLocation":400},"https://gitlab.com/-/trials/new/","nav",{"altText":402,"config":403},"Gitlab Icon",{"src":404,"dataGaName":405,"dataGaLocation":400},"https://res.cloudinary.com/about-gitlab-com/image/upload/v1758203874/jypbw1jx72aexsoohd7x.svg","gitlab icon",{"altText":402,"config":407},{"src":408,"dataGaName":405,"dataGaLocation":400},"https://res.cloudinary.com/about-gitlab-com/image/upload/v1758203875/gs4c8p8opsgvflgkswz9.svg",{"text":410,"config":411},"Get Started",{"href":412,"dataGaName":413,"dataGaLocation":400},"https://gitlab.com/-/trial_registrations/new?glm_source=about.gitlab.com/get-started/","get started",{"freeTrial":415,"mobileIcon":419,"desktopIcon":421},{"text":416,"config":417},"Learn more about GitLab Duo",{"href":74,"dataGaName":418,"dataGaLocation":400},"gitlab duo",{"altText":402,"config":420},{"src":404,"dataGaName":405,"dataGaLocation":400},{"altText":402,"config":422},{"src":408,"dataGaName":405,"dataGaLocation":400},{"button":424,"mobileIcon":429,"desktopIcon":431},{"text":425,"config":426},"/switch",{"href":427,"dataGaName":428,"dataGaLocation":400},"#contact","switch",{"altText":402,"config":430},{"src":404,"dataGaName":405,"dataGaLocation":400},{"altText":402,"config":432},{"src":433,"dataGaName":405,"dataGaLocation":400},"https://res.cloudinary.com/about-gitlab-com/image/upload/v1773335277/ohhpiuoxoldryzrnhfrh.png",{"freeTrial":435,"mobileIcon":440,"desktopIcon":442},{"text":436,"config":437},"Back to pricing",{"href":182,"dataGaName":438,"dataGaLocation":400,"icon":439},"back to pricing","GoBack",{"altText":402,"config":441},{"src":404,"dataGaName":405,"dataGaLocation":400},{"altText":402,"config":443},{"src":408,"dataGaName":405,"dataGaLocation":400},{"title":445,"button":446,"config":451},"See how agentic AI transforms software delivery",{"text":447,"config":448},"Watch GitLab Transcend now",{"href":449,"dataGaName":450,"dataGaLocation":40},"/events/transcend/virtual/","transcend event",{"layout":452,"icon":453,"disabled":27},"release","AiStar",{"data":455},{"text":456,"source":457,"edit":463,"contribute":468,"config":473,"items":478,"minimal":683},"Git is a trademark of Software Freedom Conservancy and our use of 'GitLab' is under license",{"text":458,"config":459},"View page source",{"href":460,"dataGaName":461,"dataGaLocation":462},"https://gitlab.com/gitlab-com/marketing/digital-experience/about-gitlab-com/","page source","footer",{"text":464,"config":465},"Edit this page",{"href":466,"dataGaName":467,"dataGaLocation":462},"https://gitlab.com/gitlab-com/marketing/digital-experience/about-gitlab-com/-/blob/main/content/","web ide",{"text":469,"config":470},"Please contribute",{"href":471,"dataGaName":472,"dataGaLocation":462},"https://gitlab.com/gitlab-com/marketing/digital-experience/about-gitlab-com/-/blob/main/CONTRIBUTING.md/","please contribute",{"twitter":474,"facebook":475,"youtube":476,"linkedin":477},"https://twitter.com/gitlab","https://www.facebook.com/gitlab","https://www.youtube.com/channel/UCnMGQ8QHMAnVIsI3xJrihhg","https://www.linkedin.com/company/gitlab-com",[479,526,578,622,649],{"title":180,"links":480,"subMenu":495},[481,485,490],{"text":482,"config":483},"View plans",{"href":182,"dataGaName":484,"dataGaLocation":462},"view plans",{"text":486,"config":487},"Why Premium?",{"href":488,"dataGaName":489,"dataGaLocation":462},"/pricing/premium/","why premium",{"text":491,"config":492},"Why Ultimate?",{"href":493,"dataGaName":494,"dataGaLocation":462},"/pricing/ultimate/","why ultimate",[496],{"title":497,"links":498},"Contact Us",[499,502,504,506,511,516,521],{"text":500,"config":501},"Contact sales",{"href":49,"dataGaName":50,"dataGaLocation":462},{"text":355,"config":503},{"href":357,"dataGaName":358,"dataGaLocation":462},{"text":360,"config":505},{"href":362,"dataGaName":363,"dataGaLocation":462},{"text":507,"config":508},"Status",{"href":509,"dataGaName":510,"dataGaLocation":462},"https://status.gitlab.com/","status",{"text":512,"config":513},"Terms of use",{"href":514,"dataGaName":515,"dataGaLocation":462},"/terms/","terms of use",{"text":517,"config":518},"Privacy statement",{"href":519,"dataGaName":520,"dataGaLocation":462},"/privacy/","privacy statement",{"text":522,"config":523},"Cookie preferences",{"dataGaName":524,"dataGaLocation":462,"id":525,"isOneTrustButton":27},"cookie preferences","ot-sdk-btn",{"title":85,"links":527,"subMenu":536},[528,532],{"text":529,"config":530},"DevSecOps platform",{"href":67,"dataGaName":531,"dataGaLocation":462},"devsecops platform",{"text":533,"config":534},"AI-Assisted Development",{"href":74,"dataGaName":535,"dataGaLocation":462},"ai-assisted development",[537],{"title":538,"links":539},"Topics",[540,545,550,555,560,563,568,573],{"text":541,"config":542},"CICD",{"href":543,"dataGaName":544,"dataGaLocation":462},"/topics/ci-cd/","cicd",{"text":546,"config":547},"GitOps",{"href":548,"dataGaName":549,"dataGaLocation":462},"/topics/gitops/","gitops",{"text":551,"config":552},"DevOps",{"href":553,"dataGaName":554,"dataGaLocation":462},"/topics/devops/","devops",{"text":556,"config":557},"Version Control",{"href":558,"dataGaName":559,"dataGaLocation":462},"/topics/version-control/","version control",{"text":21,"config":561},{"href":562,"dataGaName":32,"dataGaLocation":462},"/topics/devsecops/",{"text":564,"config":565},"Cloud Native",{"href":566,"dataGaName":567,"dataGaLocation":462},"/topics/cloud-native/","cloud native",{"text":569,"config":570},"AI for Coding",{"href":571,"dataGaName":572,"dataGaLocation":462},"/topics/devops/ai-for-coding/","ai for coding",{"text":574,"config":575},"Agentic AI",{"href":576,"dataGaName":577,"dataGaLocation":462},"/topics/agentic-ai/","agentic ai",{"title":579,"links":580},"Solutions",[581,583,585,590,594,597,601,604,606,609,612,617],{"text":127,"config":582},{"href":122,"dataGaName":127,"dataGaLocation":462},{"text":116,"config":584},{"href":99,"dataGaName":100,"dataGaLocation":462},{"text":586,"config":587},"Agile development",{"href":588,"dataGaName":589,"dataGaLocation":462},"/solutions/agile-delivery/","agile delivery",{"text":591,"config":592},"SCM",{"href":112,"dataGaName":593,"dataGaLocation":462},"source code management",{"text":541,"config":595},{"href":105,"dataGaName":596,"dataGaLocation":462},"continuous integration & delivery",{"text":598,"config":599},"Value stream management",{"href":155,"dataGaName":600,"dataGaLocation":462},"value stream management",{"text":546,"config":602},{"href":603,"dataGaName":549,"dataGaLocation":462},"/solutions/gitops/",{"text":165,"config":605},{"href":167,"dataGaName":168,"dataGaLocation":462},{"text":607,"config":608},"Small business",{"href":172,"dataGaName":173,"dataGaLocation":462},{"text":610,"config":611},"Public sector",{"href":177,"dataGaName":178,"dataGaLocation":462},{"text":613,"config":614},"Education",{"href":615,"dataGaName":616,"dataGaLocation":462},"/solutions/education/","education",{"text":618,"config":619},"Financial services",{"href":620,"dataGaName":621,"dataGaLocation":462},"/solutions/finance/","financial services",{"title":185,"links":623},[624,626,628,630,633,635,637,639,641,643,645,647],{"text":197,"config":625},{"href":199,"dataGaName":200,"dataGaLocation":462},{"text":202,"config":627},{"href":204,"dataGaName":205,"dataGaLocation":462},{"text":207,"config":629},{"href":209,"dataGaName":210,"dataGaLocation":462},{"text":212,"config":631},{"href":214,"dataGaName":632,"dataGaLocation":462},"docs",{"text":235,"config":634},{"href":237,"dataGaName":238,"dataGaLocation":462},{"text":230,"config":636},{"href":232,"dataGaName":233,"dataGaLocation":462},{"text":240,"config":638},{"href":242,"dataGaName":243,"dataGaLocation":462},{"text":248,"config":640},{"href":250,"dataGaName":251,"dataGaLocation":462},{"text":253,"config":642},{"href":255,"dataGaName":256,"dataGaLocation":462},{"text":258,"config":644},{"href":260,"dataGaName":261,"dataGaLocation":462},{"text":263,"config":646},{"href":265,"dataGaName":266,"dataGaLocation":462},{"text":268,"config":648},{"href":270,"dataGaName":271,"dataGaLocation":462},{"title":286,"links":650},[651,653,655,657,659,661,663,667,672,674,676,678],{"text":293,"config":652},{"href":295,"dataGaName":288,"dataGaLocation":462},{"text":298,"config":654},{"href":300,"dataGaName":301,"dataGaLocation":462},{"text":306,"config":656},{"href":308,"dataGaName":309,"dataGaLocation":462},{"text":311,"config":658},{"href":313,"dataGaName":314,"dataGaLocation":462},{"text":316,"config":660},{"href":318,"dataGaName":319,"dataGaLocation":462},{"text":321,"config":662},{"href":323,"dataGaName":324,"dataGaLocation":462},{"text":664,"config":665},"Sustainability",{"href":666,"dataGaName":664,"dataGaLocation":462},"/sustainability/",{"text":668,"config":669},"Diversity, inclusion and belonging (DIB)",{"href":670,"dataGaName":671,"dataGaLocation":462},"/diversity-inclusion-belonging/","Diversity, inclusion and belonging",{"text":326,"config":673},{"href":328,"dataGaName":329,"dataGaLocation":462},{"text":336,"config":675},{"href":338,"dataGaName":339,"dataGaLocation":462},{"text":341,"config":677},{"href":343,"dataGaName":344,"dataGaLocation":462},{"text":679,"config":680},"Modern Slavery Transparency Statement",{"href":681,"dataGaName":682,"dataGaLocation":462},"https://handbook.gitlab.com/handbook/legal/modern-slavery-act-transparency-statement/","modern slavery transparency statement",{"items":684},[685,688,691],{"text":686,"config":687},"Terms",{"href":514,"dataGaName":515,"dataGaLocation":462},{"text":689,"config":690},"Cookies",{"dataGaName":524,"dataGaLocation":462,"id":525,"isOneTrustButton":27},{"text":692,"config":693},"Privacy",{"href":519,"dataGaName":520,"dataGaLocation":462},[695],{"id":696,"title":24,"body":8,"config":697,"content":700,"description":8,"extension":25,"meta":703,"navigation":27,"path":704,"seo":705,"stem":706,"__hash__":707},"blogAuthors/en-us/blog/authors/olivier-campeau.yml",{"template":698,"gitlabHandle":699},"BlogAuthor","oli.campeau",{"name":24,"config":701},{"headshot":702},"https://res.cloudinary.com/about-gitlab-com/image/upload/v1750704785/kyqz7c4ctjvo4qpj8ldf.png",{},"/en-us/blog/authors/olivier-campeau",{},"en-us/blog/authors/olivier-campeau","QnQqFsgf6SJs5gPP9waa3s-YIi2JoRAKo6At53-Urfw",[709,720,734],{"content":710,"config":718},{"title":711,"description":712,"heroImage":713,"date":714,"category":9,"tags":715},"GitLab Patch Release: 18.10.3, 18.9.5, 18.8.9","Learn more this patch release for GitLab Community Edition and Enterprise Edition.\n\n","https://res.cloudinary.com/about-gitlab-com/image/upload/v1749661926/Blog/Hero%20Images/security-patch-blog-image-r2-0506-700x400-fy25_2x.jpg","2026-04-08",[716,717],"security releases","patch releases",{"featured":11,"template":12,"externalUrl":719},"https://about.gitlab.com/releases/2026/04/08/patch-release-gitlab-18-10-3-released/",{"content":721,"config":732},{"title":722,"description":723,"heroImage":724,"category":9,"tags":725,"authors":727,"date":730,"body":731},"Streamline test management with the SmartBear QMetry GitLab component","Learn how to automatically upload test results from GitLab CI/CD pipelines to SmartBear QMetry Test Management Enterprise using the CI/CD Catalog component.","https://res.cloudinary.com/about-gitlab-com/image/upload/v1775486753/cswmwtygkgkbdsibo09v.png",[726,9,554],"tutorial",[728,729],"Matt Genelin","Matt Bonner","2026-04-07","In modern software development, test management and continuous integration are two sides of the same coin. DevSecOps teams need seamless integration between their CI/CD pipelines and test management platforms to maintain visibility, traceability, and compliance across the software development lifecycle.\n\nThis becomes even more important as testing scales across automated pipelines, where execution data is spread across tools and harder to track in one place.\n\nFor organizations using GitLab for CI/CD and SmartBear QMetry for test management, manually uploading test results creates friction, delays feedback loops, and makes it harder to maintain a reliable, centralized view of testing.\n\nWhat if you could automatically publish your JUnit, TestNG, or other test results directly from your GitLab pipeline to QMetry with just a few lines of configuration?\n\nThat's exactly what the new **QMetry GitLab Component** enables. This reusable CI/CD component, now available in the [GitLab CI/CD Catalog](https://gitlab.com/explore/catalog), eliminates the manual overhead of test result management by automatically uploading test execution data to QMetry.  This is an AI-enabled, enterprise-grade test management platform that brings together test planning, execution, tracking, and reporting in one place.\n\nAs a centralized system of record for testing, QMetry helps teams understand coverage, track execution, and make more reliable release decisions.\n\nIn this guide, you'll learn:\n\n* How to set up the QMetry GitLab Component in your pipeline  \n* How to configure automated test result uploads  \n* Advanced configuration options for enterprise requirements  \n* A real-world aerospace industry use case  \n* Best practices for test management automation\n\nBy the end of this article, your GitLab pipelines will automatically feed test results into QMetry, giving your QA teams instant visibility into test execution and helping them make faster, more confident release decisions.\n\n![SmartBear QMetry GitLab integration](https://res.cloudinary.com/about-gitlab-com/image/upload/v1775488045/ojt707rzxnm2yr3vqxdh.png)\n\n## Why integrate GitLab with QMetry?\n\nBefore diving into the technical implementation, let's understand the value this integration delivers:\n\n### Eliminate manual test result uploads\n\nDevSecOps engineers and QA teams no longer need to manually export test results from CI/CD runs and import them into test management systems. The component handles this automatically after every pipeline execution.\n\nThis reduces manual effort while ensuring test data stays consistent, up to date, and easy to access across teams.\n\n![Test results with SmartBear QMetry GitLab integration](https://res.cloudinary.com/about-gitlab-com/image/upload/v1775488045/ajx64sihup2nursdpnxz.png)\n\n### Enable end-to-end traceability\n\nBy connecting GitLab's CI/CD execution data with QMetry's test management capabilities, teams gain complete traceability from requirements through test cases to actual test execution results. This is critical for regulated industries like financial services, aerospace, medical devices, and automotive, where audit trails are mandatory and regulatory compliance depends on demonstrating complete test coverage.\n\nIt also gives teams a clearer view of coverage and risk across releases, making it easier to understand what’s been tested and what still needs attention.\n\n### Accelerate feedback loops\n\nAutomated test result uploads mean QA teams, product managers, and stakeholders see test execution results immediately after pipeline completion – no waiting for manual data entry or report generation.\n\nWith faster access to results, teams can act immediately, reduce delays, and make quicker, more informed release decisions.\n\n### Support compliance and audit requirements\n\nFor organizations in regulated industries, maintaining comprehensive test records with proper versioning and traceability is non-negotiable. This integration ensures you can document every test execution properly in QMetry with links back to the specific GitLab pipeline, commit, and build.\n\nThis creates an audit-ready record of testing activity without adding manual overhead.\n\n![Audit-ready record of testing with SmartBear QMetry GitLab integration](https://res.cloudinary.com/about-gitlab-com/image/upload/v1775488045/q2tbaw5otgdywjkcquqx.png)\n\n### Leverage AI-powered test insights\n\nQMetry uses AI to analyze test execution patterns, identify flaky tests, predict test failures, and recommend optimization opportunities. Feeding it real-time data from GitLab pipelines maximizes the value of these AI capabilities.\n\nWith continuous data flowing in, teams get more accurate insights and can focus their efforts where it matters most.\n\n![Accurage insights with SmartBear QMetry GitLab integration](https://res.cloudinary.com/about-gitlab-com/image/upload/v1775488045/pl7ru4wx8ixnheedfyrs.png)\n\n## About the GitLab and SmartBear partnership\n\nThis component represents a growing partnership between GitLab and SmartBear to better connect CI/CD execution with test management in a single workflow. SmartBear brings deep expertise in testing, API management, and quality automation, while GitLab provides the most comprehensive AI-powered DevSecOps platform. Together, they help teams streamline how testing fits into the development lifecycle while maintaining the quality, security, and compliance standards their industries require.\n\nWhether you're managing test execution for aerospace flight control systems, financial services platforms, automotive safety applications, or medical device software, the combination of GitLab's CI/CD capabilities and QMetry's test management gives teams a centralized, reliable view of testing across the lifecycle, helping them track execution, maintain traceability, and make more confident release decisions.\n\n## What you'll need\n\nBefore getting started, ensure you have:\n\n* **A GitLab account** with a project containing automated tests that generate test result files (JUnit XML, TestNG XML, etc.)  \n* **QMetry Test Management Enterprise** account with API access enabled  \n* **QMetry API Key** generated  from your QMetry instance (we'll cover this shortly)  \n* **QMetry Project** already created where you will upload test results   \n* **Familiarity with GitLab CI/CD**, including understanding of basic `.gitlab-ci.yml` syntax and pipeline concepts  \n* **Test suite configuration** in QMetry (optional but recommended for better organization)\n\n### Understanding the test result flow\n\nHere's what happens when you integrate this component:\n\n1. **Test execution**: Your GitLab CI/CD pipeline runs automated tests (unit tests, integration tests, E2E tests, etc.).  \n2. **Result generation**: Tests produce output files in formats like JUnit XML, TestNG XML, or other supported formats.  \n3. **Component invocation**: The QMetry component executes as a job in your pipeline.  \n4. **Automatic upload**: The component reads your test result files and uploads them to QMetry via API.  \n5. **QMetry processing**: QMetry receives the results, processes them, and makes them available for reporting and analysis.\n\nThe beauty of this integration is that it happens automatically, with no manual intervention required once configured.\n\n## Part 1: Getting your QMetry API credentials\n\nBefore configuring the GitLab component, you need to obtain API access credentials from your QMetry instance. Here are the steps to follow:\n\n### 1. Access QMetry settings\n\n1. Log in to your **QMetry Test Management Enterprise** instance.  \n2. Navigate to your **user profile** (typically in the top-right corner).  \n3. Select **Settings** or **API Access** from the dropdown menu.\n\n### 2. Generate an API key\n\n1. In the API Access section, click **Generate New API Key.**  \n2. Provide a descriptive **name** for the key (e.g., \"GitLab CI/CD Integration\").  \n3. Set appropriate **permissions**. The key needs write access to upload test results.  \n4. Click **Generate.**  \n5. **Copy the API key immediately** as it will only be displayed once.\n\n**Important security note**: Treat your API key like a password. Never commit it directly to your `.gitlab-ci.yml` file or store it in plain text. We'll use GitLab CI/CD variables to store it securely.\n\n### 3. Note your QMetry instance URL\n\nYou'll also need your QMetry instance URL, which typically follows this format:\n\n```text\nhttps://your-company.qmetry.com\n```\n\nor, for self-hosted instances:\n\n```text\nhttps://qmetry.your-company.com\n```\n\nMake note of this URL because you'll need it in the next section.\n\n## Part 2: Configuring GitLab CI/CD variables\n\nNow that you have your QMetry credentials, let's store them securely in GitLab. Here are the next steps to follow:\n\n### 4. Navigate to CI/CD settings\n\n1. Open your **GitLab project.**  \n2. In the left sidebar, navigate to **Settings > CI/CD.**  \n3. Expand the **Variables** section.  \n4. Click **Add variable.**\n\n### 5. Add the QMetry API key\n\nConfigure the API key variable:\n\n| Field | Value |\n| ----- | ----- |\n| **Key** | `QMETRY_API_KEY` |\n| **Value** | Your QMetry API key from Step 2 |\n| **Type** | Variable |\n| **Flags** | ✅ Mask variable\u003Cbr>✅ Protect variable (recommended) |\n\nClick **Add variable** to save.\n\n### 6. Add the QMetry instance URL\n\nAdd a second variable for your instance URL:\n\n| Field | Value |\n| ----- | ----- |\n| **Key** | `INSTANCE_URL` |\n| **Value** | Your QMetry instance URL (e.g., `https://your-company.qmetry.com`) |\n| **Type** | Variable |\n| **Flags** | (optional: Protect variable) |\n\nClick **Add variable** to save.\n\n**Why use CI/CD variables?**\n\n* **Security**: Masked variables are hidden in job logs.  \n* **Reusability**: You can use the same credentials across multiple pipelines.  \n* **Flexibility**: It is easy to rotate credentials without modifying pipeline code.  \n* **Access control**: Protected variables are only available on protected branches.\n\n## Part 3: Understanding your test result files\n\nBefore integrating the component, ensure your tests generate output files that QMetry can process. Here are the next steps to follow:\n\n### 7. Verify test output format\n\nThe QMetry component supports multiple test result formats. The most common is **JUnit XML**, which most testing frameworks can generate:\n\n**Example JUnit XML output** (`results.xml`):\n\n```xml\n\u003C?xml version=\"1.0\" encoding=\"UTF-8\"?>\n\u003Ctestsuites>\n  \u003Ctestsuite name=\"Flight Control System Tests\" tests=\"15\" failures=\"1\" errors=\"0\" time=\"45.231\">\n    \u003Ctestcase classname=\"FlightControlTests\" name=\"testAltitudeHold\" time=\"2.341\">\n      \u003Csystem-out>Altitude hold engaged at 10,000 feet\u003C/system-out>\n    \u003C/testcase>\n    \u003Ctestcase classname=\"FlightControlTests\" name=\"testAutopilotEngagement\" time=\"3.125\">\n      \u003Csystem-out>Autopilot engaged successfully\u003C/system-out>\n    \u003C/testcase>\n    \u003Ctestcase classname=\"FlightControlTests\" name=\"testEmergencyLanding\" time=\"5.892\">\n      \u003Cfailure message=\"Landing gear failed to deploy\">\n        Expected: Landing gear deployed\n        Actual: Landing gear malfunction detected\n      \u003C/failure>\n    \u003C/testcase>\n    \u003C!-- Additional test cases... -->\n  \u003C/testsuite>\n\u003C/testsuites>\n```\n\nMost testing frameworks generate this format automatically:\n\n* **JUnit** (Java): Native format  \n* **pytest** (Python): Use `--junitxml=results.xml` flag  \n* **Jest** (JavaScript): Use `jest-junit` reporter  \n* **RSpec** (Ruby): Use `rspec_junit_formatter`  \n* **NUnit** (.NET): Use `nunit-console` with XML output  \n* **Go test**: Use `go-junit-report`\n\n### 8. Confirm test artifact configuration\n\nEnsure your existing pipeline saves test results as **artifacts**. This allows the QMetry component to access them:\n\n```yaml\ntest:\n  stage: test\n  script:\n    - npm install\n    - npm test -- --reporter=junit --reporter-options=output=results.xml\n  artifacts:\n    reports:\n      junit: results.xml\n    paths:\n      - results.xml\n    when: always  # Upload even if tests fail\n```\n\n**Key points**:\n\n* `artifacts.reports.junit` makes results visible in GitLab's test report UI.  \n* `artifacts.paths` ensures the file is available to downstream jobs.  \n* `when: always` ensures results upload even if tests fail.\n\n## Part 4: Integrating the QMetry component\n\nNow for the main event – adding the QMetry component to your pipeline. Here are the next steps to follow:\n\n### 9. Basic component integration\n\nAdd the component to your `.gitlab-ci.yml` file. The component should run **after** your tests complete:\n\n```yaml\ninclude:\n  - component: gitlab.com/sb9945614/qtm-gitlab-component/qmetry-import@1.0.5\n    inputs:\n      stage: test\n      project: \"Aerospace Flight Control System\"\n      file_name: \"results.xml\"\n      testing_type: \"JUNIT\"\n      instance_url: ${INSTANCE_URL}\n      api_key: ${QMETRY_API_KEY}\n```\n\nLet's break down each input parameter:\n\n| Parameter | Description | Example |\n| ----- | ----- | ----- |\n| `stage` | Which CI/CD stage runs the upload job | `test` |\n| `project` | Your QMetry project name or key | `\"Aerospace Flight Control System\"` |\n| `file_name` | Path to your test results file | `\"results.xml\"` |\n| `testing_type` | Format of your test results | `\"JUNIT\"` (also supports: `TESTNG`, `NUNIT`, etc.) |\n| `instance_url` | Your QMetry instance URL | `${INSTANCE_URL}` (from CI/CD variables) |\n| `api_key` | QMetry API key for authentication | `${QMETRY_API_KEY}` (from CI/CD variables) |\n\n### 10. Complete pipeline example\n\nHere's a complete `.gitlab-ci.yml` example showing test execution followed by QMetry upload:\n\n```yaml\nstages:\n  - test\n  - report\n\nvariables:\n  # Your app-specific variables\n  NODE_VERSION: \"18\"\n\n# Run your automated tests\nunit-tests:\n  stage: test\n  image: node:${NODE_VERSION}\n  script:\n    - npm ci\n    - npm run test:unit -- --reporter=junit --reporter-options=output=results.xml\n  artifacts:\n    reports:\n      junit: results.xml\n    paths:\n      - results.xml\n    when: always\n  tags:\n    - docker\n\n# Upload results to QMetry\ninclude:\n  - component: gitlab.com/sb9945614/qtm-gitlab-component/qmetry-import@1.0.5\n    inputs:\n      stage: test  # Runs in same stage as tests\n      project: \"Aerospace Flight Control System\"\n      file_name: \"results.xml\"\n      testing_type: \"JUNIT\"\n      instance_url: ${INSTANCE_URL}\n      api_key: ${QMETRY_API_KEY}\n```\n\n### 11. Run your pipeline\n\nCommit and push your changes:\n\n```shell\ngit add .gitlab-ci.yml\ngit commit -m \"Add QMetry test result integration\"\ngit push origin main\n```\n\nNavigate to your GitLab project's **CI/CD > Pipelines** to watch the execution.\n\n### 12. Verify successful upload\n\nAfter the pipeline completes, you should see:\n\n**In GitLab**:\n\n1. A new job in your pipeline named `qmetry-import` (or similar)  \n2. Job logs showing successful API communication  \n3. Green checkmark indicating successful upload\n\n**Example successful job log**:\n\n```json\n$ curl -X POST https://your-company.qmetry.com/api/v3/test-results/import \\\n  -H \"Authorization: Bearer ${QMETRY_API_KEY}\" \\\n  -H \"Content-Type: application/json\" \\\n  -d @payload.json\n\n{\n  \"status\": \"success\",\n  \"message\": \"Test results uploaded successfully\",\n  \"results_processed\": 15,\n  \"test_cases_created\": 3,\n  \"test_cases_updated\": 12,\n  \"execution_id\": \"EXE-12345\"\n}\n\nJob succeeded ```\n\n**In QMetry**:\n\n1. Navigate to your project dashboard.  \n2. Check the **Test Executions** section.  \n3. You should see a new test execution with results from your GitLab pipeline.  \n4. Click into the execution to see detailed test case results.\n\n\n## Part 5: Advanced configuration options\n\nNow that you have the basic integration working, let's explore advanced configuration for enterprise requirements. Here are the next steps to follow:\n\n### 13. Organizing results with test suites\n\nFor better organization, you can specify which QMetry test suite should receive results:\n\n```yaml\ninclude:\n  - component: gitlab.com/sb9945614/qtm-gitlab-component/qmetry-import@1.0.5\n    inputs:\n      stage: test\n      project: \"Aerospace Flight Control System\"\n      file_name: \"results.xml\"\n      testing_type: \"JUNIT\"\n      testsuite_name: \"Sprint 23 Regression Tests\"\n      testsuite_id: \"TS-456\"  # Optional: Use existing test suite ID\n      instance_url: ${INSTANCE_URL}\n      api_key: ${QMETRY_API_KEY}\n```\n\n**When to use test suites**:\n\n* Organizing tests by sprint or release  \n* Separating regression tests from new feature tests  \n* Grouping tests by component or subsystem  \n* Creating test execution hierarchies for reporting\n\n### 14. Configuring automation hierarchy levels\n\nQMetry supports hierarchical test organization. Use the `automation_hierarchy` parameter to specify the organization level:\n\n```yaml\ninclude:\n  - component: gitlab.com/sb9945614/qtm-gitlab-component/qmetry-import@1.0.5\n    inputs:\n      stage: test\n      project: \"Aerospace Flight Control System\"\n      file_name: \"results.xml\"\n      testing_type: \"JUNIT\"\n      automation_hierarchy: \"2\"  # Level 2 hierarchy\n      instance_url: ${INSTANCE_URL}\n      api_key: ${QMETRY_API_KEY}\n```\n\n**Hierarchy levels explained**:\n\n* **Level 1**: Top-level test suites (e.g., \"All Regression Tests\")  \n* **Level 2**: Sub-suites (e.g., \"Flight Control Tests\" under \"Regression Tests\")  \n* **Level 3**: Granular test groups (e.g., \"Altitude Hold Tests\" under \"Flight Control\")\n\n### 15. Multiple test result files\n\nFor complex projects with multiple test jobs, you can invoke the component multiple times:\n\n```yaml\nstages:\n  - test\n\n# Unit tests\nunit-tests:\n  stage: test\n  script:\n    - npm run test:unit\n  artifacts:\n    paths:\n      - unit-results.xml\n    when: always\n\n# Integration tests\nintegration-tests:\n  stage: test\n  script:\n    - npm run test:integration\n  artifacts:\n    paths:\n      - integration-results.xml\n    when: always\n\n# Upload unit test results\ninclude:\n  - component: gitlab.com/sb9945614/qtm-gitlab-component/qmetry-import@1.0.5\n    inputs:\n      stage: test\n      project: \"Aerospace Flight Control System\"\n      file_name: \"unit-results.xml\"\n      testing_type: \"JUNIT\"\n      testsuite_name: \"Unit Tests - Sprint 23\"\n      instance_url: ${INSTANCE_URL}\n      api_key: ${QMETRY_API_KEY}\n\n  # Upload integration test results\n  - component: gitlab.com/sb9945614/qtm-gitlab-component/qmetry-import@1.0.5\n    inputs:\n      stage: test\n      project: \"Aerospace Flight Control System\"\n      file_name: \"integration-results.xml\"\n      testing_type: \"JUNIT\"\n      testsuite_name: \"Integration Tests - Sprint 23\"\n      instance_url: ${INSTANCE_URL}\n      api_key: ${QMETRY_API_KEY}\n```\n\n### 16. Custom runner tags\n\nFor enterprise environments with dedicated runners, specify runner tags:\n\n```yaml\ninclude:\n  - component: gitlab.com/sb9945614/qtm-gitlab-component/qmetry-import@1.0.5\n    inputs:\n      stage: test\n      runner_tag: \"production-runners\"  # Use specific runner pool\n      project: \"Aerospace Flight Control System\"\n      file_name: \"results.xml\"\n      testing_type: \"JUNIT\"\n      instance_url: ${INSTANCE_URL}\n      api_key: ${QMETRY_API_KEY}\n```\n\n### 17. Custom test suite folders\n\nOrganize test suites into folders for better project structure:\n\n```yaml\ninclude:\n  - component: gitlab.com/sb9945614/qtm-gitlab-component/qmetry-import@1.0.5\n    inputs:\n      stage: test\n      project: \"Aerospace Flight Control System\"\n      file_name: \"results.xml\"\n      testing_type: \"JUNIT\"\n      testsuite_folder_path: \"/Regression/Sprint-23/Flight-Controls\"\n      instance_url: ${INSTANCE_URL}\n      api_key: ${QMETRY_API_KEY}\n```\n\nThis creates a folder hierarchy in QMetry:\n\n```none\nAerospace Flight Control System/\n└── Regression/\n    └── Sprint-23/\n        └── Flight-Controls/\n            └── [Your test execution]\n```\n\n### 18. Advanced field mapping\n\nFor enterprise QMetry instances with custom fields, use the `testcase_fields` and `testsuite_fields` parameters:\n\n```yaml\ninclude:\n  - component: gitlab.com/sb9945614/qtm-gitlab-component/qmetry-import@1.0.5\n    inputs:\n      stage: test\n      project: \"Aerospace Flight Control System\"\n      file_name: \"results.xml\"\n      testing_type: \"JUNIT\"\n      testcase_fields: \"priority=P1,component=FlightControl,certification=DO-178C\"\n      testsuite_fields: \"release=v2.4.0,sprint=23\"\n      instance_url: ${INSTANCE_URL}\n      api_key: ${QMETRY_API_KEY}\n```\n\nThis adds custom metadata to test cases and suites for enhanced filtering and reporting.\n\n## Part 6: Real-world use cases\n\nLet's explore how organizations across different industries are using this integration to solve critical quality and compliance challenges.\n\n### Financial services: Enterprise banking platforms\n\nLeading financial institutions are evolving their engineering practices with integrated DevOps platforms. These organizations face unique challenges when managing test automation at scale.\n\n**The challenge for financial services**:\n\n* **Regulatory compliance**: Financial services must maintain detailed audit trails for all testing activities.  \n* **Multiple compliance frameworks**: Firms must adhere to FCA, PSD2, GDPR, and internal risk management policies.  \n* **High-frequency deployments**: Multiple production deployments are required daily across microservices.  \n* **Zero-tolerance for failures**: Banking systems require extremely high reliability.  \n* **Distributed teams**: QA teams need real-time visibility across global engineering teams.\n\n**The solution**: Financial services organizations implementing the QMetry GitLab Component can automate test result uploads across their CI/CD pipelines for:\n\n* Unit tests for hundreds of microservices  \n* API contract tests for inter-service communication  \n* End-to-end transaction flow tests  \n* Security and compliance scanning results  \n* Performance and load testing results\n\n**Example implementation approach**:\n\n```yaml\n# Financial services approach: Separate test uploads by test type\nstages:\n  - test\n  - security\n  - report\n\n# Unit tests for payment processing service\nunit-tests:\n  stage: test\n  script:\n    - mvn clean test\n  artifacts:\n    paths:\n      - target/surefire-reports/TEST-*.xml\n    when: always\n\n# Upload to QMetry with compliance metadata\ninclude:\n  - component: gitlab.com/sb9945614/qtm-gitlab-component/qmetry-import@1.0.5\n    inputs:\n      stage: report\n      project: \"Payment Processing Platform\"\n      file_name: \"target/surefire-reports/TEST-*.xml\"\n      testing_type: \"JUNIT\"\n      testsuite_name: \"Payment Services - Unit Tests\"\n      testsuite_folder_path: \"/Regulatory/FCA-Compliance/Unit-Tests\"\n      testcase_fields: \"compliance=FCA,risk_level=high,service=payments\"\n      automation_hierarchy: \"2\"\n      instance_url: ${INSTANCE_URL}\n      api_key: ${QMETRY_API_KEY}\n```\n\n**Potential business outcomes for financial services**:\n\n* **Significant reduction** in manual test reporting time  \n* **Complete audit trail coverage** for regulatory reviews  \n* **Real-time visibility** for distributed QA teams  \n* **Faster time-to-production** with automated quality gates  \n* **Enhanced compliance posture** with complete traceability from requirements to test execution\n\n### Aerospace flight control testing\n\nLet's explore how an aerospace company might use this integration for critical flight control system testing.\n\n**Aerospace software development faces unique requirements and challenges:**\n\n* **DO-178C compliance**: Aviation software must follow strict certification standards  \n* **Complete traceability**: Every requirement must link to test cases and execution results  \n* **Audit trails**: Regulators require detailed records of all testing activities  \n* **Safety-critical quality**: Failures can have catastrophic consequences  \n* **Multiple test levels**: Unit, integration, system, and certification tests\n\n**The solution:** By integrating GitLab CI/CD with QMetry, the aerospace engineering team achieves automated test execution and reporting.\n\n\n```yaml\nstages:\n  - build\n  - unit-test\n  - integration-test\n  - system-test\n  - report\n\n# Build flight control firmware\nbuild-firmware:\n  stage: build\n  script:\n    - make clean\n    - make build TARGET=flight-control\n  artifacts:\n    paths:\n      - build/flight-control.bin\n\n# Unit tests (DO-178C Level A)\nunit-tests:\n  stage: unit-test\n  script:\n    - make test-unit OUTPUT=junit\n  artifacts:\n    paths:\n      - test-results/unit-tests.xml\n    when: always\n\n# Hardware-in-the-loop integration tests\nhil-integration-tests:\n  stage: integration-test\n  tags:\n    - hil-test-bench  # Dedicated hardware test environment\n  script:\n    - ./scripts/deploy-to-test-bench.sh\n    - ./scripts/run-hil-tests.sh\n  artifacts:\n    paths:\n      - test-results/hil-tests.xml\n    when: always\n\n# System-level certification tests\ncertification-tests:\n  stage: system-test\n  tags:\n    - certification-environment\n  script:\n    - ./scripts/run-certification-suite.sh\n  artifacts:\n    paths:\n      - test-results/certification-tests.xml\n    when: always\n  only:\n    - main  # Only run on main branch\n\n# Upload unit test results to QMetry\ninclude:\n  - component: gitlab.com/sb9945614/qtm-gitlab-component/qmetry-import@1.0.5\n    inputs:\n      stage: report\n      project: \"Flight Control System v2.4\"\n      file_name: \"test-results/unit-tests.xml\"\n      testing_type: \"JUNIT\"\n      testsuite_name: \"Unit Tests - DO-178C Level A\"\n      testsuite_folder_path: \"/Certification/DO-178C/Unit\"\n      testcase_fields: \"compliance=DO-178C,level=A,safety_critical=true\"\n      automation_hierarchy: \"2\"\n      instance_url: ${INSTANCE_URL}\n      api_key: ${QMETRY_API_KEY}\n\n  # Upload HIL test results\n  - component: gitlab.com/sb9945614/qtm-gitlab-component/qmetry-import@1.0.5\n    inputs:\n      stage: report\n      project: \"Flight Control System v2.4\"\n      file_name: \"test-results/hil-tests.xml\"\n      testing_type: \"JUNIT\"\n      testsuite_name: \"Hardware-in-Loop Integration Tests\"\n      testsuite_folder_path: \"/Certification/DO-178C/Integration\"\n      testcase_fields: \"compliance=DO-178C,level=A,test_type=HIL\"\n      automation_hierarchy: \"2\"\n      instance_url: ${INSTANCE_URL}\n      api_key: ${QMETRY_API_KEY}\n\n  # Upload certification test results\n  - component: gitlab.com/sb9945614/qtm-gitlab-component/qmetry-import@1.0.5\n    inputs:\n      stage: report\n      project: \"Flight Control System v2.4\"\n      file_name: \"test-results/certification-tests.xml\"\n      testing_type: \"JUNIT\"\n      testsuite_name: \"System Certification Tests\"\n      testsuite_folder_path: \"/Certification/DO-178C/System\"\n      testcase_fields: \"compliance=DO-178C,level=A,certification_ready=true\"\n      automation_hierarchy: \"1\"\n      instance_url: ${INSTANCE_URL}\n      api_key: ${QMETRY_API_KEY}\n```\n\n### The results\n\n**Before integration**:\n\n* QA engineers manually exported test results from GitLab  \n* Imported results into QMetry through UI uploads  \n* Process took 2-3 hours per test cycle  \n* Human error risk in data entry  \n* Delayed feedback to stakeholders\n\n**After integration**:\n\n* Test results automatically flow from GitLab to QMetry  \n* Complete audit trail from commit → test → result  \n* Zero manual intervention required  \n* Real-time visibility for certification auditors  \n* Compliance reports generated automatically\n\n**Example QMetry dashboard after integration**:\n\n```none\n╔════════════════════════════════════════════════════════════╗\n║  Flight Control System v2.4 - Test Execution Dashboard     ║\n╠════════════════════════════════════════════════════════════╣\n║                                                            ║\n║  📊 Test Execution Summary (Last 7 Days)                   ║\n║  ───────────────────────────────────────────────────────── ║\n║  ✓ Total Tests Executed: 1,247                             ║\n║  ✓ Passed: 1,241 (99.5%)                                   ║\n║  ✗ Failed: 6 (0.5%)                                        ║\n║  ⏸ Skipped: 0                                              ║\n║                                                            ║\n║  📁 Test Suite Organization                                ║\n║  ───────────────────────────────────────────────────────── ║\n║  └─ Certification/                                         ║\n║     └─ DO-178C/                                            ║\n║        ├─ Unit/ (487 tests, 100% pass)                     ║\n║        ├─ Integration/ (623 tests, 99.2% pass)             ║\n║        └─ System/ (137 tests, 100% pass)                   ║\n║                                                            ║\n║  🔗 Traceability                                           ║\n║  ───────────────────────────────────────────────────────── ║\n║  Requirements Covered: 342/342 (100%)                      ║\n║  Test Cases Linked: 1,247/1,247 (100%)                     ║\n║  GitLab Pipeline Executions: 47 (automated)                ║\n║                                                            ║\n║  ⚠️  Action Items                                          ║\n║  ───────────────────────────────────────────────────────── ║\n║  • 6 failed tests require investigation                    ║\n║  • Last execution: 2 minutes ago (Pipeline #1543)          ║\n║  • GitLab Commit: a7f8c23 \"Fix altitude hold logic\"        ║\n║                                                            ║\n╚════════════════════════════════════════════════════════════╝\n```\n\n### Compliance and audit benefits\n\nBoth financial services and aerospace organizations can leverage this integration for compliance:\n\n**For financial services (FCA, PSD2, SOX)**:\n\n1. **Automated traceability**: Link regulatory requirements → test cases → execution results → GitLab commits  \n2. **Audit-ready documentation**: Complete test execution history with timestamps and pipeline references  \n3. **Risk management**: Real-time quality dashboards for risk assessment  \n4. **Regulatory reporting**: Generate compliance reports directly from QMetry test data\n\n**For aerospace certification (DO-178C, DO-254)**:\n\n1. **Automated traceability matrix**: QMetry links requirements → test cases → execution results → GitLab commits  \n2. **Immutable audit trail**: Every test execution is timestamped with pipeline ID, commit SHA, and executor  \n3. **Certification package generation**: QMetry generates compliant documentation pulling data from GitLab pipelines  \n4. **Real-time compliance dashboards**: Auditors can view test coverage and execution history in real-time\n\n## Complete configuration reference\n\nHere's a comprehensive reference of all available component inputs:\n\n| Input Parameter | Required | Default | Description |\n| ----- | ----- | ----- | ----- |\n| `stage` | No | `test` | GitLab CI/CD stage for the upload job |\n| `runner_tag` | No | `\"\"` | Specific runner tag to use (empty = any available runner) |\n| `project` | Yes | - | QMetry project name or key |\n| `file_name` | Yes | - | Path to test results file (relative to project root) |\n| `testing_type` | Yes | - | Test result format: `JUNIT`, `TESTNG`, `NUNIT`, etc. |\n| `skip_warning` | No | `\"1\"` | Skip warnings during import (`\"1\"` = skip, `\"0\"` = show) |\n| `is_matching_required` | No | `\"false\"` | Match existing test cases by name (`\"true\"` or `\"false\"`) |\n| `testsuite_name` | No | `\"\"` | Name for the test suite in QMetry |\n| `testsuite_id` | No | `\"\"` | Existing test suite ID to append results to |\n| `testsuite_folder_path` | No | `\"\"` | Folder path for organizing test suites (e.g., `/Regression/Sprint-23`) |\n| `automation_hierarchy` | No | `\"\"` | Hierarchy level for test organization (`\"1\"`, `\"2\"`, `\"3\"`, etc.) |\n| `testcase_fields` | No | `\"\"` | Custom fields for test cases (comma-separated: `field1=value1,field2=value2`) |\n| `testsuite_fields` | No | `\"\"` | Custom fields for test suites (comma-separated: `field1=value1,field2=value2`) |\n| `instance_url` | Yes | - | QMetry instance URL (store in CI/CD variable) |\n| `api_key` | Yes | - | QMetry API key (store in CI/CD variable, masked) |\n\n## Best practices for production use\n\nAs you scale your integration, follow these best practices:\n\n### Security\n\n* ✅ **Always use CI/CD variables** for sensitive data (API keys, URLs)  \n* ✅ **Mask and protect** API key variables  \n* ✅ **Rotate API keys** periodically (quarterly recommended)  \n* ✅ **Restrict API key permissions** to minimum required (write to test results only)  \n* ✅ **Use protected branches** for production test uploads\n\n### Performance\n\n* ✅ **Keep test result files reasonable size** (\\\u003C 10 MB recommended)  \n* ✅ **Split large test suites** into multiple jobs/files  \n* ✅ **Use parallel test execution** to reduce pipeline duration  \n* ✅ **Cache dependencies** to speed up test execution\n\n### Organization\n\n* ✅ **Use consistent naming conventions** for test suites and folder paths  \n* ✅ **Leverage custom fields** for filtering and reporting  \n* ✅ **Create folder hierarchies** that mirror your test strategy  \n* ✅ **Document your integration** in project README files\n\n### Troubleshooting\n\n* ✅ **Review job logs** for API communication details  \n* ✅ **Verify test result file format** matches `testing_type` parameter  \n* ✅ **Check QMetry project exists** and API key has access  \n* ✅ **Ensure test result files** are available as pipeline artifacts\n\n## Summary and next steps\n\nCongratulations! You've successfully integrated GitLab CI/CD with QMetry Test Management Enterprise. Your setup now provides:\n\n* **Automated test result uploads** – No more manual exports and imports \n\n* **Real-time visibility** – QA teams see results immediately after pipeline execution \n\n* **Complete traceability** – Link GitLab commits, pipelines, and test executions \n\n* **Enhanced compliance** – Maintain audit trails for regulated industries \n\n* **Scalable quality processes** – Support growing test suites without added overhead\n\n### What happens now\n\nEvery time your GitLab pipeline runs:\n\n1. Tests execute and generate result files.  \n2. The QMetry component automatically uploads results to your instance.  \n3. QA teams, stakeholders, and auditors see results in QMetry dashboards.  \n4. AI-powered insights analyze execution patterns and identify improvements.  \n5. Compliance reports generate automatically with full traceability.\n\n### Expand your integration\n\nNow that you have the basic integration working, consider these advanced scenarios:\n\n* **Bi-directional integration**: Use QMetry's API to trigger GitLab pipelines from test management workflows.\n\n* **Multi-project deployments**: Scale the component across your organization's GitLab projects.\n\n* **Custom reporting**: Build dashboards combining GitLab pipeline metrics with QMetry test analytics.\n\n* **Scheduled test execution**: Use GitLab scheduled pipelines to run regression suites nightly.\n\n## Learn more and get help\n\n### Documentation and resources\n\n* **Component documentation**: [GitLab CI/CD Catalog](https://gitlab.com/explore/catalog)  \n* **QMetry documentation**: [QMetry Support Portal](https://qmetrysupport.atlassian.net/wiki/spaces/QPro/overview)  \n* **SmartBear resources**: [SmartBear Academy](https://smartbear.com/resources/)  \n* **GitLab CI/CD documentation**: [GitLab CI/CD Documentation](https://docs.gitlab.com/ee/ci/)\n\n### Support\n\n**For component technical questions**:\n\n* Visit the [component repository](https://gitlab.com/sb9945614/qtm-gitlab-component).  \n* Open an issue on the project.  \n* Check existing issues for common questions.\n\n**For QMetry product questions**:\n\n* Contact SmartBear support at support@smartbear.com.  \n* Visit the [QMetry Community Forum](https://community.smartbear.com/).",{"featured":27,"template":12,"slug":733},"streamline-test-management-with-the-smartbear-qmetry-gitlab-component",{"content":735,"config":745},{"title":736,"description":737,"authors":738,"heroImage":740,"date":730,"body":741,"category":9,"tags":742},"GitLab Duo CLI: Agentic AI for the development lifecycle, now in the terminal","Developers who work outside the IDE and GitLab UI can access GitLab Duo Agent Platform in the terminal with built-in security controls and headless mode support.",[739],"John Coghlan","https://res.cloudinary.com/about-gitlab-com/image/upload/v1775561395/bhe1as7ttjvzltxwgo5m.png","Debugging a broken pipeline at the end of a sprint, or wiring AI into a CI/CD workflow that runs without anyone watching, is exactly where today's AI assistants fall short given their focus on coding – which is only a portion of the software lifecycle. They're built for interactive coding sessions, not automation across different stages of software development. GitLab Duo CLI, now in public beta, is built for both.\n\nGitLab Duo CLI brings agentic AI powered by [Duo Agent Platform](https://about.gitlab.com/gitlab-duo-agent-platform/) to the terminal with full support for automated workflows, alongside an interactive chat mode when you need a human in the loop. This article highlights what Duo CLI does, how its two operating modes work, and the security model behind it.\n\n## How to install GitLab Duo CLI\n\nIf you already have GLab (the GitLab CLI) installed, enter:\n\n```\nglab duo cli\n```\n\nThen follow the prompts.\n\nIf you don't have GLab yet, you can [install it here](https://gitlab.com/gitlab-org/cli/#installation) or [use GitLab Duo CLI as a standalone tool](https://docs.gitlab.com/user/gitlab_duo_cli/#without-the-gitlab-cli).\n\n## Why the terminal, and why now\n\nThe first wave of AI assistants for software development lived in the IDE, and focused solely on coding. That made sense when the job was autocomplete. But as AI agents start *doing things* across every stage of the software lifecycle, e.g. running tests, triggering pipelines, monitoring vulnerability scans, and more, the IDE may no longer be the only abstraction needed to get the job done.\n\nThe best developer tools are ones that work for both humans and machines. CLIs have had decades of design iteration toward that goal. They're composable. You can pipe output, chain commands, and drop them into scripts. They're debuggable: when something goes wrong, you run the same command yourself and see exactly what the agent saw. And they're transparent. No background processes, no initialization dance, no protocol to decode when things break.\n\nTerminal interfaces are better for automation, scripting, and environment portability. IDE interfaces are better for interactive, context-rich development. GitLab Duo CLI is designed for the former, while Duo Agentic Chat in the IDE and UI covers the latter.\n\n## What GitLab Duo CLI can do\n\nWith GitLab Duo CLI, developers can build, modify, refactor, and modernize code — similar to other AI-powered coding assistants built for the terminal. But that’s not where they stop. Any agent and flow defined within GitLab Duo Agent Platform is accessible via Duo CLI, whether it is to automate CI/CD configuration and optimize pipelines, or to perform multi-step development tasks autonomously across the entire software development lifecycle.\n\nGitLab Duo CLI runs in two modes:\n\n* **Interactive mode**, an editor-agnostic terminal chat experience with human-in-the-loop approval before any action is taken. Use it to understand codebase structure, create code, fix errors, or troubleshoot broken pipelines.  \n* **Headless mode**, non-interactive, designed for runners, scripts, and automated workflows. Drop it into CI/CD and let it work without handholding.\n\n## AI with guardrails\n\nAgentic AI that can take actions creates real security exposure. GitLab Duo CLI addresses this at the platform level, not as an afterthought:\n\n* **Human-in-the-loop by default** in interactive mode, so no action is taken without approval.  \n* **Prompt injection detection** is built into the GitLab Duo Agent Platform, not bolted on.  \n* **Composite identity** limits what the agent can access and makes every AI-driven action auditable.\n\nGitLab Duo CLI also supports [custom instruction files](https://docs.gitlab.com/user/duo_agent_platform/customize/), e.g. `chat-rules.md`, `AGENTS.md`, and `SKILL.md`, that define which tasks, resources, context, knowledge, and actions your agents are permitted to take. **This is the principle of least privilege applied to AI: Your agent does exactly what you've authorized, and nothing more.**\n\nWatch GitLab Duo CLI in action:\n\u003Ciframe src=\"https://player.vimeo.com/video/1179964611?badge=0&autopause=0&player_id=0&app_id=58479\" frameborder=\"0\" allow=\"autoplay; fullscreen; picture-in-picture; clipboard-write; encrypted-media; web-share\" referrerpolicy=\"strict-origin-when-cross-origin\" style=\"position:absolute;top:0;left:0;width:100%;height:100%;\" title=\"GitLab Duo CLI Beta Demo V1\">\u003C/iframe>\u003Cscript src=\"https://player.vimeo.com/api/player.js\">\u003C/script>\n\n## Use GitLab Duo CLI today\n\nYou can experience the benefits of GitLab Duo CLI by [starting a free trial of GitLab Duo Agent Platform](https://about.gitlab.com/gitlab-duo-agent-platform/). \n\nIf you are already using GitLab in the free tier, you can sign up for GitLab Duo Agent Platform by [following a few simple steps](https://docs.gitlab.com/subscriptions/gitlab_credits/#for-the-free-tier-on-gitlabcom). \n\nAnd if you are an existing subscriber to GitLab Premium or Ultimate, you can take advantage of GitLab Duo CLI by simply [turning on Duo Agent Platform](https://docs.gitlab.com/user/duo_agent_platform/turn_on_off/) and start using the GitLab Credits [that are included](https://docs.gitlab.com/subscriptions/gitlab_credits/#included-credits) with your subscription.",[743,9,744],"AI/ML","features",{"featured":27,"template":12,"slug":746},"gitlab-duo-cli",{"promotions":748},[749,763,774],{"id":750,"categories":751,"header":753,"text":754,"button":755,"image":760},"ai-modernization",[752],"ai-ml","Is AI achieving its promise at scale?","Quiz will take 5 minutes or less",{"text":756,"config":757},"Get your AI maturity score",{"href":758,"dataGaName":759,"dataGaLocation":238},"/assessments/ai-modernization-assessment/","modernization assessment",{"config":761},{"src":762},"https://res.cloudinary.com/about-gitlab-com/image/upload/v1772138786/qix0m7kwnd8x2fh1zq49.png",{"id":764,"categories":765,"header":766,"text":754,"button":767,"image":771},"devops-modernization",[9,32],"Are you just managing tools or shipping innovation?",{"text":768,"config":769},"Get your DevOps maturity score",{"href":770,"dataGaName":759,"dataGaLocation":238},"/assessments/devops-modernization-assessment/",{"config":772},{"src":773},"https://res.cloudinary.com/about-gitlab-com/image/upload/v1772138785/eg818fmakweyuznttgid.png",{"id":775,"categories":776,"header":778,"text":754,"button":779,"image":783},"security-modernization",[777],"security","Are you trading speed for security?",{"text":780,"config":781},"Get your security maturity score",{"href":782,"dataGaName":759,"dataGaLocation":238},"/assessments/security-modernization-assessment/",{"config":784},{"src":785},"https://res.cloudinary.com/about-gitlab-com/image/upload/v1772138786/p4pbqd9nnjejg5ds6mdk.png",{"header":787,"blurb":788,"button":789,"secondaryButton":794},"Start building faster today","See what your team can do with the intelligent orchestration platform for DevSecOps.\n",{"text":790,"config":791},"Get your free trial",{"href":792,"dataGaName":45,"dataGaLocation":793},"https://gitlab.com/-/trial_registrations/new?glm_content=default-saas-trial&glm_source=about.gitlab.com/","feature",{"text":500,"config":795},{"href":49,"dataGaName":50,"dataGaLocation":793},1777309979151]