Cài đặt & Cấu hình

Yêu cầu hệ thống

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

Cài đặt toàn cục

Vì @aquaringlab/aidk là một package riêng tư trên GitHub Packages, bạn cần cấu hình xác thực với GitHub Packages trước khi cài đặt.

1. Tạo GitHub Personal Access Token (PAT):

   • Truy cập github.com/settings/tokens → Generate new token (Classic).
   • Chọn scope read:packages.
   • Nhấn "Generate token" và sao chép mã token.

2. Cấu hình .npmrc:

   Thêm đoạn sau vào file ~/.npmrc hoặc .npmrc trong thư mục dự án của bạn, thay thế YOUR_GITHUB_PAT bằng mã token bạn vừa tạo:

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

3. Cài đặt:

   Sau khi đã cấu hình .npmrc, bạn chạy lệnh sau để cài đặt CLI toàn cục:

npm install -g @aquaringlab/aidk

Kiểm tra cài đặt

aidk --version

Khởi tạo dự án

Trong thư mục gốc của dự án của bạn, chạy:

aidk init

Lệnh này sẽ:

1. Tạo thư mục .agent/ với cấu trúc rules, skills, và workflows.
2. Tạo thư mục docs/ai/ với template tài liệu.
3. Tạo file .ai-devkit.json với cấu hình dự án.

Cấu trúc sau khi khởi tạo

your-project/
├── .agent/
│   ├── rules/          # Quy tắc hướng dẫn AI
│   ├── skills/         # Kỹ năng chuyên biệt của AI
│   └── workflows/      # Lệnh slash workflows
├── docs/
│   └── ai/
│       ├── requirements/
│       ├── design/
│       ├── planning/
│       ├── implementation/
│       └── testing/
└── .ai-devkit.json

Cấu hình .ai-devkit.json

File .ai-devkit.json lưu trữ thông tin cấu hình của dự án:

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

Trường	Mô tả
version	Phiên bản config
cliVersion	Phiên bản AIDK CLI
environments	Môi trường hệ thống (cursor, antigravity, claude-code)