Getting Started

1. Installation

Install ai-jue and the required presets in your project:

npm install -D ai-jue jue-preset-base

2. Initialization

Run the initialization command in your project root to create the configuration file:

npx jue init

The interactive process looks like this:

Initializing ai-jue...
Create ai.config.js? (Y/n) Y
Enter preset name (default: base): base
Created ai.config.js
Create .ai directory structure? (Y/n) Y
Created .ai directory with AGENTS.md, rules/, commands/, skills/, agents/, hooks/, tools/ subdirectories.

3. Applying Configuration

Run the apply command to generate AI tool configuration files based on your settings:

npx jue apply --all

ai-jue will read ai.config.js, load presets and local .ai assets; if root AGENTS.md exists, it is auto-injected as global context, then generate target files (for example CLAUDE.md, .cursor/rules/*.mdc, .gemini/settings.json; Cursor consumes root AGENTS.md natively).

4. Common Commands

Check for Updates

Check if installed presets have newer versions:

npx jue check

Validate Configuration

Validate ai.config.js and referenced assets for correctness:

npx jue validate

Watch Mode

Watch for configuration changes during development and automatically re-apply:

npx jue apply --all --watch

Create New Preset

Quickly scaffold a new preset project structure:

npx jue create-preset my-preset

For more detailed configuration, please refer to the Configuration Guide.