Qodo

https://docs.qodo.ai/
Admin
Qodo provides comprehensive documentation to set up, configure, and govern its AI Platform code...
Tokens:217,286
Snippets:2,211
Trust Score:10
Update:2 days ago
Show doc for...
Tokens:
Raw
### Example best_practices.md file

Source: https://docs.qodo.ai/qodo-ide/code-intelligence/best-practices

A sample best_practices.md file showing general code structure guidelines and YAML configuration examples for navigation and theme customization.

```markdown
# Qodo best practices

## General code structure

- **Consistent Naming Conventions**: Use descriptive and consistent naming for variables, functions, and classes. For example, use camelCase for variables and functions, and PascalCase for class names.

- **Documentation and Comments**: Ensure all functions, classes, and modules have comprehensive docstrings. Use the `/docstring` command to generate or improve documentation.

- **Code Modularity**: Break down large functions into smaller, reusable components. This enhances readability and maintainability.

## YAML configuration

- **Navigation Structure**: Organize navigation in YAML files using nested lists for hierarchical structures. Ensure each section is clearly defined and logically grouped.

```yaml
nav: 
    - 'index.md'
    - Installation:
    - 'installation/index.md'
    - 'installation/vscode.md'
```

- **Theme Customization**: Define custom themes and palettes in the YAML configuration to maintain a consistent look and feel across the documentation.

```yaml
theme:
    name: material
    palette:
    - media: "(prefers-color-scheme: light)"
        scheme: default
```
```

--------------------------------

### Install Jira Python client

Source: https://docs.qodo.ai/integrations/ticketing-integrations/jira

Install the required Jira library to validate your PAT authentication setup.

```bash
pip install jira==3.8.0
```

--------------------------------

### Install Qodo from Qodo registry

Source: https://docs.qodo.ai/on-prem/qodo-on-prem-helm-chart-overview

Pull the chart from the OCI registry, unpack it, and perform the installation using the base configuration file from within the chart.

```bash
helm pull oci://artifacts-self-hosted.qodo.ai/codium-stack/qodo-onprem/qodo-onprem \
  --version <chart-version> --untar

helm upgrade --install qodo ./qodo-onprem \
  --namespace "$NAMESPACE" \
  -f qodo-onprem/onprem-base.yaml \
  -f my-values.yaml
```

--------------------------------

### Monitor installation progress

Source: https://docs.qodo.ai/on-prem/qodo-on-prem-helm-chart-overview

Watch the status of pods in the specified namespace to confirm the installation is proceeding.

```bash
kubectl get pods -n "$NAMESPACE" -w
```

--------------------------------

### Install Qodo from local bundle

Source: https://docs.qodo.ai/on-prem/qodo-on-prem-helm-chart-overview

Use Helm to upgrade or install the Qodo chart using a local bundle and specified values files.

```bash
helm upgrade --install qodo ./qodo-onprem \
  --namespace "$NAMESPACE" \
  -f onprem-base.yaml \
  -f my-values.yaml
```

--------------------------------

### Get Rules workflow example

Source: https://docs.qodo.ai/agentic-toolbox/agentic-toolbox-get-rules-skill

An example workflow demonstrating the execution of the get-rules command to load global, domain-specific, and repository-level rules for a task.

```text
get-rules

task: add retries to the payments client

Global
→ Error handling: no silent catches

Payments
→ Idempotency keys on every write

Repo
→ Structured logging conventions

Loaded before the first line is written
```

--------------------------------

### Example .pr_agent.toml Configuration

Source: https://docs.qodo.ai/configuration/configuration-file

An example configuration file showing provider-specific sections and general review agent settings. Select only one provider section that matches your git environment.

```toml
⚠️ Select ONLY ONE section below, the one that matches your git provider.
# Do not include multiple provider sections in the same configuration file.

# GitHub App
[github_app]
pr_commands = [
    "/agentic_describe",
    "/agentic_review"
]

# GitLab
[gitlab]
pr_commands = [
    "/agentic_describe",
    "/agentic_review"
]

# Bitbucket Cloud
[bitbucket_app]
pr_commands = [
    "/agentic_describe",
    "/agentic_review"
]

# Bitbucket Server / Data Center
[bitbucket_server]
pr_commands = [
    "/agentic_describe",
    "/agentic_review"
]

# Azure DevOps
[azure_devops_server]
pr_commands = [
    "/agentic_describe",
    "/agentic_review"
]

[review_agent]
comments_location_policy = "both"

# severity threshold rank for inline comments:
# 3=action_required,
# 2=remediation_recommended,
# 1=informational.
# Only findings with rank >= threshold will be published inline
inline_comments_severity_threshold = 3

# Extra prompt for usecase to be added as instruction for the agent
issues_user_guidelines = ""
compliance_user_guidelines = ""
```

--------------------------------

### Install Qodo Skills via npx

Source: https://docs.qodo.ai/agent-skills

Use this command to install all available Qodo skills into your AI coding agent environment.

```bash
npx skills add qodo-ai/qodo-skills
```

--------------------------------

### Example output of qodo tools command

Source: https://docs.qodo.ai/agentic-toolbox/qodo-tools-overview

Shows the list of available tools categorized by their read/write capabilities.

```text
[READ] qodo codebase find
[READ] qodo codebase grep
[READ] qodo codebase read-file
[READ] qodo cross-repo overview
[READ] qodo pull-request similar
[READ] qodo pr-review-session findings
[READ] qodo rules search
```

--------------------------------

### Run Qodo readiness check script

Source: https://docs.qodo.ai/on-prem/qodo-on-prem-helm-chart-overview

Execute the readiness check script to verify prerequisites before and after installation.

```bash
./qodo-check.sh -n <namespace> -f <your-values.yaml>
```

--------------------------------

### Identify integration installation failure

Source: https://docs.qodo.ai/code-review/troubleshooting/review-comments-not-appearing

This pattern indicates that the PR-Agent app is not installed or the PR cannot be found.

```text
PR not found, or PR-Agent app is not installed on the repository
```

--------------------------------

### Create database and user for existing PostgreSQL instance

Source: https://docs.qodo.ai/on-prem/git-integration/set-up-postgres-database

Run these commands as a superuser to create the role and database, then reconnect to configure schema permissions.

```sql
-- Run as superuser
CREATE ROLE qodo_merge_user LOGIN PASSWORD 'your-password';
GRANT qodo_merge_user TO postgres;  -- replace 'postgres' with your superuser
CREATE DATABASE qodo_merge OWNER qodo_merge_user;
```

```sql
-- Run as qodo_merge_user
\c qodo_merge
REVOKE CREATE ON SCHEMA public FROM PUBLIC;
GRANT USAGE, CREATE ON SCHEMA public TO qodo_merge_user;
```

--------------------------------

### Install Agentic Toolbox on Windows PowerShell

Source: https://docs.qodo.ai/agentic-toolbox/cli

Use this command to install the Agentic Toolbox on Windows via PowerShell. Administrator privileges are not required.

```powershell
powershell -ExecutionPolicy Bypass -Command "irm https://get.qodo.ai/install.ps1 | iex"
```

--------------------------------

### Install Agentic Toolbox on macOS and Linux

Source: https://docs.qodo.ai/agentic-toolbox/cli

Use this command to install the Agentic Toolbox on macOS, Linux, Git Bash, or WSL environments.

```bash
curl -fsSL https://get.qodo.ai | sh
```

--------------------------------

### Deploy Qodo Review using Helm

Source: https://docs.qodo.ai/on-prem/git-integration/set-up-postgres-database

Execute the standard Helm command to deploy or upgrade the application.

```bash
helm upgrade --install qodo-merge ./module-<version>.tgz \
  -f ./values.yaml \
  -n qodo-merge
```

--------------------------------

### Response schemas

Source: https://docs.qodo.ai/api-reference/api-reference/invite-users-to-the-organization

Examples of response structures for various HTTP status codes.

```json
{
  "message": "<string>",
  "data": [
    {}
  ]
}
```

```json
{
  "detail": "<string>"
}
```

```json
{
  "detail": "<string>"
}
```

```json
{
  "detail": "<string>"
}
```

```json
{
  "detail": {
    "redirectTo": "<string>"
  }
}
```

```json
{
  "detail": [
    {
      "type": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>"
    }
  ]
}
```

```json
{
  "detail": "<string>"
}
```

```json
{
  "detail": "<string>"
}
```
Tokens:
Raw