Q Developer in CI/CD & IDE Workflows
Integrating Q Developer suggestions and scans into a team's pipeline.
//
Search across all documentation pages
Integrating Q Developer suggestions and scans into a team's pipeline.
Unlike Q Business, Amazon Q Developer is not something you build an application on top of via a service SDK. It is a product you use directly: an extension in your IDE, a command you run in a terminal, and a step you can add to a CI/CD pipeline. This page is honest about that shape - there is no boto3/SDK-v3 client to demonstrate here, so the examples are CLI commands and CI configuration rather than a CodeGroup. Treat every exact command and flag below as illustrative and verify it against current AWS documentation before wiring it into a real pipeline.
Quick-reference recipe - the three places Q Developer shows up.
# 1. IDE - install the "Amazon Q" extension in VS Code or a JetBrains IDE, then sign in.
# Inline suggestions and an in-editor chat panel become available against your open project.
# 2. CLI - install the Amazon Q Developer CLI, then start an interactive session.
q chat # verify exact subcommand/flags against current AWS CLI docs
# 3. CI/CD - add a Q Developer step/action to your pipeline (e.g. a GitHub Actions workflow)
# to run an automated code review or a scan on each pull request.When to reach for this:
A representative team setup: the IDE plugin for day-to-day coding, the CLI for terminal work, and a CI step that reviews pull requests.
# --- IDE (VS Code / JetBrains) ---
# 1. Install the "Amazon Q" extension from the relevant marketplace.
# 2. Sign in with AWS Builder ID or your organization's IAM Identity Center.
# 3. Use inline "Tab to accept" suggestions while typing, and open the Q chat
# panel to ask questions scoped to your open files/project.
# --- CLI ---
# 1. Install the Q Developer CLI for your platform (verify current install method).
# 2. Authenticate once per machine.
q chat # interactive session in the terminal
# e.g. ask it to explain a file, draft a commit message, or propose a fix# --- CI/CD (illustrative GitHub Actions step - verify current action name/inputs) ---
name: Q Developer Code Review
on: [pull_request]
jobs:
q-review:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Amazon Q Developer review
uses: aws-actions/amazon-q-developer-review@v1 # verify exact action name/version
with:
aws-region: us-east-1What this demonstrates:
Every other page in this section shows genuine qbusiness operations because Q Business is a service with a real API surface meant for applications to build on. Q Developer's value, by contrast, is delivered through direct developer tooling - an editor plugin, a CLI, and CI hooks - rather than an API meant for your backend to call on a user's behalf. Forcing a CodeGroup with invented SDK calls here would be inaccurate, so this page stays in CLI/CI-config territory and says so plainly.
Installed into VS Code or a JetBrains IDE, the plugin gives inline code completions as you type and an in-editor chat you can ask about the code you have open - explain this function, write a test, fix this error. It authenticates once (AWS Builder ID for individual use, or your organization's IAM Identity Center for enterprise use) and then works against your local project context.
The CLI brings a similar assistant into a terminal session, useful for questions that do not need an open editor - explaining a shell command, drafting a commit message, or getting a quick fix suggestion while working outside an IDE. The interactive entry point is commonly referred to as something like q chat or q dev in AWS's own materials, but treat the exact subcommand and flags as something to verify against current docs, since CLI surfaces iterate faster than service APIs.
In a pipeline, Q Developer typically shows up as a step or action that runs against a pull request: an automated code review that comments on the diff, a security/quality scan, or an automated upgrade flow that opens a PR for a routine dependency or language-version bump. The mechanics are pipeline-specific - a GitHub Actions step, a CodeBuild/CodePipeline integration, or similar - and the exact action name and configuration inputs are worth confirming against current AWS documentation rather than assuming the illustrative YAML above is exact.
Because there is no application SDK here, adoption is a developer-tooling decision (which IDE plugin to install, which CI step to add) rather than an architecture decision the way standing up Q Business is. Rolling it out mostly means picking sign-in method (Builder ID vs Identity Center), installing the plugin/CLI across the team, and deciding which pipelines get an automated review step.
qbusiness exists for Q Business. Fix: plan for IDE/CLI/CI integration, not application code calling it directly.| Approach | Use When | Don't Use When |
|---|---|---|
| Q Developer IDE plugin (this page) | Day-to-day inline coding help and in-editor chat | You need programmatic, application-level access to a coding assistant |
| Q Developer CLI (this page) | Terminal-first workflows, quick ad hoc questions | You need it embedded in a GUI IDE experience |
| Q Developer CI/CD step (this page) | Automated first-pass review or routine upgrade PRs | Your pipeline needs deterministic, rule-based checks only (lint/type-check already covers it) |
| Amazon Q Business chat (see rest of this section) | The question is about company knowledge, not code | The question is about code the assistant should read/write directly |
Not in the same sense. Q Developer is used mainly through an IDE plugin, a CLI, and CI/CD integration rather than an application service SDK you call from backend code.
Through its CLI, run interactively in a terminal (commonly an entry point like q chat) - verify the current exact command against AWS docs, since CLI syntax evolves.
Yes, typically as a step/action that runs an automated code review, scan, or upgrade flow against a pull request. Confirm the exact action name and configuration for your CI system.
It can authenticate via an individual AWS Builder ID or via your organization's IAM Identity Center, depending on how your team has set it up.
Treat automated review/scan output as a first-pass signal, not an automatic merge gate, unless you've validated its accuracy for your codebase and team norms.
Because Q Developer's genuine surface here is CLI and CI configuration, not SDK calls. Forcing a boto3/SDK-v3 example would misrepresent the product.
Stack versions: This page was written for boto3 1.43.x (Python 3.10+) and the AWS SDK for JavaScript v3 (Node.js 18+).
Reviewed by Chris St. John·Last updated Jul 25, 2026