Skip to content

Getting Started ​

1. Installation ​

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

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

2. Initialization ​

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

bash
npx jue init

The interactive process looks like this:

text
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:

bash
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, .codex/config.toml; Cursor consumes root AGENTS.md natively).

4. Common Commands ​

The following commands are available.

CI Check ​

It checks config and Artifact drift:

bash
npx jue apply --all --check

Watch Mode ​

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

bash
npx jue apply --all --watch

Create New Preset ​

bash
npx jue create-preset my-preset

See the Configuration Guide.

Define once. Adapt everywhere.