🇺🇸English

Get Qodo Rules Skill

Description

Fetches repository-specific coding rules from the Qodo platform API before code generation or modification tasks. Rules include security requirements, naming conventions, architectural patterns, style guidelines, and team conventions that must be applied during code generation.

Workflow

Step 1: Check if Rules Already Loaded

If rules are already loaded (look for "Qodo Rules Loaded" in recent messages), skip to step 6.

Step 2: Verify working in a git repository

• Check that the current directory is inside a git repository. If not, inform the user that a git repository is required and exit gracefully.
• Extract the repository scope from the git origin remote URL. If no remote is found, exit silently. If the URL cannot be parsed, inform the user and exit gracefully.
• Detect module-level scope: if inside a modules/* subdirectory, use it as the query scope; otherwise use repository-wide scope.

See repository scope detection for details.

Step 3: Verify Qodo Configuration

Check that the required Qodo configuration is present. The default location is ~/.qodo/config.json.

• API key : Read from ~/.qodo/config.json (API_KEY field). If not found, inform the user that an API key is required and provide setup instructions, then exit gracefully.
• Environment name : Read from ~/.qodo/config.json (ENVIRONMENT_NAME field), with QODO_ENVIRONMENT_NAME environment variable taking precedence. If not found, inform the user that an API key is required and provide setup instructions, then exit gracefully.
• API URL override (optional): Read from ~/.qodo/config.json (QODO_API_URL field). If present, the skill will use {QODO_API_URL}/rules/v1 as the API endpoint, ignoring ENVIRONMENT_NAME. If absent, the ENVIRONMENT_NAME-based URL is used.
• Request ID : Generate a UUID (e.g. via uuidgen or python3 -c "import uuid; print(uuid.uuid4())") to use as request-id for all API calls in this invocation. This correlates all page fetches for a single rules load on the platform side.

Example config parsing:

API_KEY=$(python3 -c "import json,os; c=json.load(open(os.path.expanduser('~/.qodo/config.json'))); print(c['API_KEY'])")
ENV_NAME=$(python3 -c "import json,os; c=json.load(open(os.path.expanduser('~/.qodo/config.json'))); print(c.get('ENVIRONMENT_NAME',''))")
QODO_API_URL=$(python3 -c "import json,os; c=json.load(open(os.path.expanduser('~/.qodo/config.json'))); print(c.get('QODO_API_URL',''))")
REQUEST_ID=$(uuidgen || python3 -c "import uuid; print(uuid.uuid4())")
# Determine API_URL: QODO_API_URL takes precedence over ENVIRONMENT_NAME
if [ -n "$QODO_API_URL" ]; then
  API_URL="${QODO_API_URL}/rules/v1"
elif [ -z "$ENV_NAME" ]; then
  API_URL="https://qodo-platform.qodo.ai/rules/v1"
else
  API_URL="https://qodo-platform.${ENV_NAME}.qodo.ai/rules/v1"
fi

Step 4: Fetch Rules with Pagination

• Fetch all pages from the API (50 rules per page) until no more results are returned.
• On each page, handle HTTP errors and exit gracefully with a user-friendly message.
• Accumulate all rules across pages into a single list.
• Stop after 100 pages maximum (safety limit).
• If no rules are found after all pages, inform the user and exit gracefully.

Example API request (page 1):

curl -s \
  -H "Authorization: Bearer $API_KEY" \
  -H "request-id: $REQUEST_ID" \
  -H "qodo-client-type: skill-qodo-get-rules" \
  "$API_URL/rules?scopes=$ENCODED_SCOPE&state=active&page=1&page_size=50"

See pagination details for the full algorithm, URL construction, and error handling.

Step 5: Format and Output Rules

• Print the "📋 Qodo Rules Loaded" header with repository scope, scope context, and total rule count.
• Group rules by severity and print each non-empty group: ERROR, WARNING, RECOMMENDATION.
• Each rule is formatted as: - **{name}** ({category}): {description}
• End output with ---.

See output format details for the exact format.

Step 6: Apply Rules by Severity

Step 7: Report

After code generation, inform the user about rule application:

• ERROR rules applied : List which rules were followed
• WARNING rules skipped : Explain why
• No rules applicable : Inform: "No Qodo rules were applicable to this code change"
• RECOMMENDATION rules : Mention only if they influenced a design decision

How Scope Levels Work

Determines scope from git remote and working directory (see Step 2):

Scope Hierarchy :

• Universal (/) - applies everywhere
• Org Level (/org/) - applies to organization
• Repo Level (/org/repo/) - applies to repository
• Path Level (/org/repo/path/) - applies to specific paths

Configuration

See README.md for full configuration instructions, including API key setup and environment variable options.

Common Mistakes

• Re-running when rules are loaded - Check for "Qodo Rules Loaded" in context first
• Missing compliance comments on ERROR rules - ERROR rules require a comment documenting compliance
• Forgetting to report when no rules apply - Always inform the user when no rules were applicable, so they know the rules system is active
• Not in git repo - Inform the user that a git repository is required and exit gracefully; do not attempt code generation
• No API key - Inform the user with setup instructions; set QODO_API_KEY or create ~/.qodo/config.json
• No rules found - Inform the user; set up rules at app.qodo.ai

Weekly Installs

61

Repository

qodo-ai/qodo-skills

GitHub Stars

12

First Seen

Feb 23, 2026

Security Audits

Gen Agent Trust HubPassSocketPassSnykWarn

Installed on

github-copilot60

cursor58

codex58

opencode58

gemini-cli57

amp57