Use Cases and Examples

Make Any IDE Agentic with Qodo Gen CLI

You can turn any IDE into an agentic development environment using the terminal-based Qodo Gen CLI. Here's how:

1. Open your IDE of choice (e.g., Visual Studio, Eclipse).

2. Open the integrated terminal within the IDE.

3. Start Qodo Gen CLI by running:

   qodo

   This launches the CLI in standard terminal mode.

4. For a more interactive experience, run the CLI with the UI flag:

   qodo --ui

   This provides a richer interface for interacting with the agent.

With these steps, your IDE becomes an agentic workspace, enabling seamless collaboration with Qodo's capabilities right from your development environment.

---

Qodo Aware: Remote Codebase Intelligence

Note: This feature is available for Enterprise users only.

Qodo Aware can help you better understand your company's code and answer more complex questions about your projects.

Using Retrieval-Augmented Generation (RAG), a technique that combines retrieval-based methods with generative models to enhance the quality and relevance of generated content, Qodo Aware can understand your company's codebase better, gain deeper context about your projects and answer more complicated or specific questions.

For more information on Qodo Aware, contact Qodo support.

---

Built-in Agents

Add Qodo's ready-to-use agents to your CLI, designed to support a wide range of developer workflows out of the box:

Leverage Qodo Merge: Review Agent

Code reviews are often delayed or require multiple rounds of changes. This agent helps you catch issues early so PRs are ready for human review:

agents/agents/code-review at main · qodo-ai/agentsGitHub

Generate Test Suites: Diff-test Agent

An intelligent test generation agent that analyzes code diffs and automatically generates comprehensive test suites covering all changed behaviors.

agents/agents/diff-test-suite at main · qodo-ai/agentsGitHub

Increase Test Coverage: Test Coverage Agent

Writing thorough tests is time-consuming and often skipped, making your test coverage low. This agent generates the missing tests for you during the PR process.

This agent is a GitHub Workflow that invokes the Qodo Gen CLI Action with a custom agent.

# .github/workflows/qodo-cover.yml
name: Test Coverage Bot
on:
  pull_request:
    branches:
      - main
    types:
      - labeled


permissions:
  pull-requests: write
  contents: write


jobs:
  coverage:
    # Only run if:
    # 1. PR has the qodo-cover label
    # 2. PR is open (not closed or draft)
    if: |
      contains(github.event.label.name, 'qodo-cover') &&
      github.event.pull_request.state == 'open' &&
      github.event.pull_request.draft == false
    runs-on: ubuntu-latest
    
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        
      - name: Run Qodo Coverage Bot
        uses: qodo-ai/qodo-gen-cli@v1
        with:
          prompt: "qodo-cover"
          # agentfile: "${{ github.workspace }}/agent.toml"
          key-value-pairs: |
            desired_coverage=90
        env:
          QODO_API_KEY: ${{ secrets.QODO_API_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          PR_NUMBER: ${{ github.event.pull_request.number }}

What does the Test Coverage Agent do?

• The workflow is triggered when a qodo-cover label is added to an open PR

• It uses the qodo-cover prompt to:

  • Analyze which changed files need test coverage

  • Generate appropriate tests for uncovered code

  • Create a follow-up PR with the new tests targeting the original PR branch

• Targets a desired coverage threshold of 90%

You get high-quality test coverage with almost no manual work. Instead of spending hours writing boilerplate tests, the agent creates them for you and sends a clean PR ready to review and merge.

Note: this agent requires the QODO_API_KEY secret set in your repository.

Documentation Agent

Release notes are often skipped or written last minute, leading to incomplete or unclear changelogs. This agent automates the process by generating release notes from your Git history.

# .github/workflows/qodo-release-notes.yml
name: Release Notes Generator


on:
  workflow_dispatch:
    inputs:
      target_tag:
        description: "Generate notes up to (and including) this tag; blank = HEAD"
        required: false


permissions:
  contents: write
  pull-requests: write
  issues: read
  id-token: write


jobs:
  release_notes:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4


      - name: Qodo release-notes agent
        uses: qodo-ai/qodo-gen-cli@v1
        with:
          prompt: qodo-release-notes
          # agentfile: "${{ github.workspace }}/agent.toml"
          key-value-pairs: |
            target_tag=${{ github.event.inputs.target_tag }}
            notes_file=RELEASE_NOTES.md
        env:
          QODO_API_KEY: ${{ secrets.QODO_API_KEY }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

What does the Documentation Agent do?

It defines a manually-dispatched bot that generates release notes for a given PR tag.

The bot analyzes all commits, PRs and issues since the last release, and create a new PR that updates the release notes file with the new release notes.

You can configure this agent in the agent configuration.

Note: this agent requires the QODO_API_KEY secret set in your repository.