Installation & Setup

System Requirements

• Node.js >= 24
• npm >= 10

Global Installation

Since @aquaringlab/aidk is a private package hosted on GitHub Packages, you must configure authentication with GitHub Packages before installation.

1. Generate a GitHub Personal Access Token (PAT):

   • Go to github.com/settings/tokens → Generate new token (Classic).
   • Select the read:packages scope.
   • Click "Generate token" and copy it.

2. Configure .npmrc:

   Add the following to your ~/.npmrc or project-level .npmrc, replacing YOUR_GITHUB_PAT with the token you just generated:

@aquaringlab:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=YOUR_GITHUB_PAT

3. Installation:

   After configuring .npmrc, run the following command to install the CLI globally:

npm install -g @aquaringlab/aidk

Verify Installation

aidk --version

Initialize a Project

Inside your project root, run:

aidk init

This will:

1. Create the .agent/ directory with rules, skills, and workflows structure.
2. Create the docs/ai/ directory with documentation templates.
3. Create a .ai-devkit.json configuration file.

Resulting Project Structure

your-project/
├── .agent/
│   ├── rules/          # AI guidance rules
│   ├── skills/         # Specialized AI skills
│   └── workflows/      # Slash command workflows
├── docs/
│   └── ai/
│       ├── requirements/
│       ├── design/
│       ├── planning/
│       ├── implementation/
│       └── testing/
└── .ai-devkit.json

.ai-devkit.json Configuration

This file stores project-level AIDK configuration:

{
  "version": "1.0.0",
  "cliVersion": "0.1.0",
  "environments": ["cursor", "antigravity", "claude-code"]
}

Field	Description
version	Config version
cliVersion	AIDK CLI version
environments	Target environments (cursor, antigravity, claude-code)