Qodo Documentation
HomepageBlogCommunityGet Started
  • Overview
  • Qodo Gen
  • Qodo Portal
  • On Prem
  • Introduction
  • Quickstart
  • Setup and Installation
    • VSCode Installation
    • JetBrains Installation
    • Sign In
    • Extension Settings
    • Uninstall
  • Qodo Gen Chat
    • Agentic Mode
      • Agentic Tools (MCPs)
      • Built-in Tools (MCPs)
    • Standard Mode
      • Focus
        • Current File Focus
        • Git Diff Focus
      • Context
        • Add Entire Folder or Project as Context
        • Add Image as Context
      • Commands
        • /ask
        • /changelog
        • /commit
        • /describe
        • /docstring
        • /enhance
        • /explain
        • /find-on-github
        • /generate-best-practices
        • /help
        • /improve
        • /issues
        • /recap
        • /review
    • Inline Context
    • Chat History
    • Model Selection
    • Chat Preferences
  • CLI
    • Setup and Quickstart
    • Creating and Managing Agents
    • CI and Automation
  • Company Codebase (RAG)
    • Tagging
    • Configuration File
  • Code Completion
  • Test Generation
    • Configuring Your Test Setup
  • Data Sharing
  • Release Notes
Powered by GitBook
LogoLogo

Terms and Privacy

  • Terms of Use
  • Privacy Policy
  • Data Processing

© 2025 Qodo. All Rights Reserved.

On this page
  • Installation
  • Starting to use Qodo Gen CLI
  • API key
  • Quickstart
  • Qodo Gen Chat - Interactive AI Chat Mode
  • AI Model selection
  • GitHub Example Repository
  • Qodo built-in tools
  • Available Commands and Flags

Was this helpful?

  1. CLI

Setup and Quickstart

PreviousCLINextCreating and Managing Agents

Last updated 4 days ago

Was this helpful?

Qodo Gen CLI is now available in alpha release.

Installation

To use Qodo Gen CLI, you’ll need and installed.

To install, run:

npm install -g @qodo/gen

Starting to use Qodo Gen CLI

To start using Qodo Gen CLI, run the initialization command:

qodo init

API key

Once login is completed you'll receive an API key in the terminal.

The API key is also saved locally in the .qodo folder in your home dir, and can be reused (e.g., in CI).

The key is tied to your user account and subject to the same usage limits.


Quickstart

Qodo Gen Chat - Interactive AI Chat Mode

qodo chat

In this mode you can send prompts such as:

Write tests for the files in the auth directory

Add better logging througout my project

Use Qodo Merge to describe the changes in my working folder

And Qodo Gen CLI will follow your guidelines.

The response is a markdown-formatted output.

You can exit at any time by pressing Escape.

AI Model selection

You can use a specific AI model with --model=<model_name>.

For a list of available model names, run qodo models.

GitHub Example Repository

Qodo built-in tools

Qodo Gen CLI comes with built-in tools that run in its backend: a web search tool and a Qodo Merge tool.


Available Commands and Flags

Command
Description

login

Authenticate and receive API key

init

Start using Qodo Gen CLI and generate starter agent configuration file

chat

Use Qodo Gen Chat

--chat

Keep interacting with the CLI after the run is done instead of immediately exiting

create-agent

<command-name>

Run a configured agent

--agentfile=path

<command-name> --mcp

Run an agent as a service (listening on port 3000)

mcp-list

List available local and remote tools

models

List available models

--model=model_name

Specify a custom model to use

--ci

--mcp

--ui

Open Qodo Gen CLI with web interface

--webhook

-h, --help

View all available commands and flags

-l, --log=path

Redirect console output to a file (directed in the path), or to stdout or stderr

--silent

Suppress all console output except the final result. Logs go to /dev/null

--resume=session_id

Resume a task with the given session ID

docker run --rm qodoai/gen

Run Qodo Gen CLI on docker

Run directly in your terminal:

Find working examples and templates:

Create a by translating user requirements into a valid TOML configuration

Specify a custom path to an

Run commands in

Run all configured agents as tools in

Run commands as tools from agent.toml in

Node.js
npm
Qodo Gen Chat
https://github.com/qodo-ai/qodo-gen-cli
new agent
agent TOML file
CI mode
MCP-server mode
webhook mode