ドキュメント
CLI ツール
npx ak2 コマンドでレシピやエフェクトを管理する
概要
AK2Engine CLI はレシピやエフェクトをプロジェクトに追加するためのツールです。
コマンド一覧
npx ak2 add
レシピやエフェクトをプロジェクトに追加します。
# セクションレシピを追加
npx ak2 add hero-basic
# エフェクトを追加
npx ak2 add BgEffectSnow
# 複数同時に追加
npx ak2 add hero-basic cta-basic BgEffectSnow BgEffectFirefly
セクションレシピは src/_sections/ に、エフェクトは src/_effects/ に配置されます。
既に同名のファイルが存在する場合はスキップされます（上書きしません）。
npx ak2 create
レシピやエフェクトを新規作成します。スケルトン生成と、既存レシピからのフォークに対応しています。
セクション作成:
# スケルトンから新規作成
npx ak2 create my-hero
# 既存レシピをフォークして作成
npx ak2 create my-hero --from hero-basic
--from を指定すると、元のレシピをコピーし、ファイル名・CSS クラス名（BEM __ -- 含む）・CSS 変数名を新しい名前に一括置換します。
エフェクト作成:
# スケルトンから新規作成
npx ak2 create BgEffectCustom --effect
# 既存エフェクトをフォークして作成
npx ak2 create BgEffectCustom --effect --from BgEffectSnow
エフェクト名は BgEffect で始める必要があります。--from ではクラス名と window 登録名が自動でリネームされます。
--from のソース検索順序:
- ローカルの
_sections/または_effects/ - エンジンパッケージ内
- GitHub（registry 経由）
npx ak2 save
ローカルで作成・編集したセクションやエフェクトを ak2-recipes にレシピとして保存します。
# セクションを保存
npx ak2 save my-hero "カスタムヒーロー。2カラム対応。"
# エフェクトを保存（名前が BgEffect で始まる場合は自動判定）
npx ak2 save BgEffectCustom "カスタムエフェクト。"
保存先の ak2-recipes ディレクトリは以下の順で検出されます。
- 環境変数
AK2_RECIPES_DIR - CLI 実行ディレクトリの
../ak2-recipes
保存時に registry.json も自動で更新されます（ak2-recipes 内とエンジン内の両方）。
npx ak2 list
利用可能なレシピとエフェクトの一覧を表示します。
# 全一覧
npx ak2 list
# セクションレシピのみ
npx ak2 list sections
# エフェクトのみ
npx ak2 list effects
npx ak2 help
ヘルプを表示します。
ダウンロード元
CLI は以下の順序でファイルを取得します。
- ローカル（プロジェクト内の
_sections/_effects/） - エンジンパッケージ内（npm インストール済みの場合）
- GitHub リポジトリ（ak2-recipes）--- オンライン時
レジストリ
利用可能なレシピ・エフェクトは registry.json に登録されています。npx ak2 save でレシピを保存すると、レジストリも自動で更新されます。