メインコンテンツまでスキップ

インストールとセットアップ

システム要件​

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

グローバルインストール​

@aquaringlab/aidk は GitHub Packages 上のプライベートパッケージであるため、インストールする前に GitHub Packages での認証を設定する必要があります。

  1. GitHub 個人アクセストークン (PAT) の生成:

    • github.com/settings/tokens → Generate new token (Classic) に移動します。
    • read:packages スコープを選択します。
    • "Generate token" をクリックし、トークンをコピーします。

  2. .npmrc の設定:

    ~/.npmrc またはプロジェクトレベルの .npmrc に以下の内容を追加し、YOUR_GITHUB_PAT を生成したトークンに置き換えます：

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

  1. インストール:

    .npmrc を設定した後、以下のコマンドを実行して CLI をグローバルにインストールします：

npm install -g @aquaringlab/aidk

インストール確認​

aidk --version

プロジェクトの初期化​

プロジェクトのルートディレクトリで実行します：

aidk init

これにより：

  1. rules、skills、workflowsの構造を持つ .agent/ ディレクトリが作成されます。
  2. ドキュメントテンプレートを持つ docs/ai/ ディレクトリが作成されます。
  3. .ai-devkit.json 設定ファイルが作成されます。

初期化後のプロジェクト構造​

your-project/
├── .agent/
│   ├── rules/          # AIガイダンスルール
│   ├── skills/         # 専門的なAIスキル
│   └── workflows/      # スラッシュコマンドワークフロー
├── docs/
│   └── ai/
│       ├── requirements/
│       ├── design/
│       ├── planning/
│       ├── implementation/
│       └── testing/
└── .ai-devkit.json

.ai-devkit.json の設定​

このファイルはプロジェクトレベルのAIDK設定を保存します：

{
  "version": "1.0.0",
  "cliVersion": "0.1.0",
  "environments": ["cursor", "antigravity", "claude-code"]
}
フィールド説明
version設定バージョン
cliVersionAIDK CLIバージョン
environments対象環境（cursor、antigravity、claude-code）