Setup and Quickstart

Note: If you are using a single-tenant deployment, please contact your account team or Qodo support to enable the Qodo Gen CLI.

Installation

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

To install, run:

npm install -g @qodo/gen

Starting to use Qodo Gen CLI

To start using Qodo Gen CLI, you need to log in first:

qodo login

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.

There are a few commands that let you maintain the API key:

qodo key list               # List all API keys

qodo key create <name>      # Create a new API key with the given name

qodo key revoke <name>      # Revoke an API key by name

Quickstart

Qodo Gen Chat - Interactive AI Chat Mode

Run Qodo Gen Chat directly in your terminal:

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.

Interactive Web UI Mode

Use the Qodo web interface:

qodo --ui

The interactive web UI mode features full interactivity, and the same capabilities as in the terminal.

GitHub Example Repository

Find working examples and templates: https://github.com/qodo-ai/qodo-gen-cli

Last updated

Was this helpful?