Skip to main content

CLI Reference

Command Overview

aidk [command] [options]
CommandDescription
aidk initInitialize AIDK structure in the current project
aidk add rule <name>Add a new rule
aidk add skill <name>Add a new skill
aidk add workflow <name>Add a new workflow
aidk updateCheck and update components from the registry
aidk --versionPrint current version
aidk --helpDisplay help

aidk init

Initialize AIDK in the current directory.

aidk init

Options:

  • --ide <cursor|antigravity> — Target IDE (default: antigravity)
  • --force — Overwrite if structure already exists

Examples:

# Initialize for Cursor IDE
aidk init --ide cursor

# Overwrite existing structure
aidk init --force

aidk add rule

Add a new rule file to .agent/rules/.

aidk add rule <name>

Example:

aidk add rule security
# Creates: .agent/rules/security.md

aidk add skill

Add a new skill to .agent/skills/.

aidk add skill <name>

Example:

aidk add skill fastapi
# Creates: .agent/skills/fastapi/SKILL.md

aidk add workflow

Add a new workflow to .agent/workflows/.

aidk add workflow <name>

Example:

aidk add workflow deploy
# Creates: .agent/workflows/deploy.md

aidk update

Check for changes in installed components and discover new components from the registry.

aidk update

This command performs the following actions:

  1. Check for Changes: Compares the current rules, skills, and workflows in your project with the latest versions in the AIDK registry.
  2. Discover New Components: Automatically identifies new components (rules, skills, workflows) available in the registry that you haven't installed yet.
  3. Selective Update: Provides an interactive interface for you to choose whether to update everything or select specific components.

Example:

# Check and update the entire project
aidk update

Common Errors

ErrorCauseSolution
Command not found: aidkNot installed or PATH not setRun npm install -g @caeruxlab/aidk
ENOENT: .agent already existsDirectory already existsUse --force flag
403 Forbiddennpm registry auth errorCheck .npmrc and GitLab token