Godot AI DevKit CLI

Command-line tool for managing Godot AI DevKit projects. Use gadk (or godot-ai-devkit) to initialize projects, add agents and skills, validate project health, and clean runtime artifacts.

Installation

npm install -g godot-ai-devkit

Or run directly with npx:

npx godot-ai-devkit init my-game

Quick Start

# Initialize a new Godot project with AI DevKit support
gadk init my-game

# Add an agent to the project
gadk add agent gdscript-writer

# Add a skill
gadk add skill tilemap-best-practices

# List installed agents and skills
gadk list

# Check project health
gadk doctor

# Clean up runtime artifacts
gadk clean-runtime

Commands

gadk init <project-name>

Initialize a new Godot project with the AI DevKit directory structure, default CLAUDE.md, .gitignore, and base configuration.

Options:

• --genre <genre> — Apply a genre template (rpg, platformer, roguelike, puzzle, fps, rts, visual-novel, simulation, arcade, horror, metroidvania)
• --size <size> — Project size template (small, medium, large; default: medium)
• --no-git — Skip git initialization

gadk add <type> <name>

Add an agent or skill to the current project.

Types:

• agent — Add an agent file (e.g., gadk add agent gdscript-writer)
• skill — Add a skill file (e.g., gadk add skill signal-architecture)

Options:

• --from <path> — Install from a local directory instead of the built-in catalog
• --dry-run — Show what would be installed without writing files

gadk list

List all installed agents, skills, and project metadata.

Options:

• --agents — Show only agents
• --skills — Show only skills
• --json — Output as JSON

gadk update

Update installed agents and skills to their latest versions.

Options:

• --agent <name> — Update a specific agent
• --skill <name> — Update a specific skill
• --check — Check for updates without applying

gadk doctor

Run diagnostics on the project. Checks:

• Directory structure matches conventions
• All agent references in CLAUDE.md resolve to actual files
• No 3.x deprecated API usage in GDScript files
• .gitignore includes Godot-specific entries
• No missing skill references

gadk clean-runtime

Clean runtime artifacts and stale files:

• .godot/ editor cache (ask confirmation)
• *.import files with broken references
• Orphaned session files
• Duplicate UID resources

Options:

• --dry-run — Show what would be cleaned without deleting
• --force — Skip confirmation prompts
• --sessions — Clean only session artifacts

Configuration

The CLI reads configuration from gadk.config.json in the project root:

{
  "projectName": "my-game",
  "godotVersion": "4.3",
  "genre": "platformer",
  "size": "medium",
  "agents": ["gdscript-writer", "gdscript-reviewer"],
  "skills": ["signal-architecture", "tilemap-best-practices"],
  "cli": {
    "confirmBeforeClean": true,
    "backupBeforeUpdate": true
  }
}

Development

# Clone and install
git clone https://github.com/godot-ai-devkit/godot-ai-devkit
cd godot-ai-devkit/cli
npm install

# Run tests
npm test

# Run locally
node bin/godot-ai-devkit.js doctor