capawesome-cli

Capawesome CLI

認証、プロジェクトのリンク、コマンドの実行、CI/CD との統合のために、Capawesome CLI（@capawesome/cli）をインストール、設定して使用します。

前提条件

1. Node.js（v18 以降）と npm がインストールされていること。
2. Capawesome Cloud のアカウントと組織があること。

一般的なルール

@capawesome/cli コマンドを初めて実行する前に、--help フラグを付けて実行し、利用可能なオプションをすべて確認してください。

MCP サーバー

Capawesome MCP server は最新の Capawesome ドキュメントを提供するため、このスキルに含まれるガイダンスよりも常に新しい情報を確認できます。API トークンを使用すると、Capawesome Cloud 管理 API も利用できます。

• Capawesome MCP ツールを利用できる場合は、search_docs を呼び出してトピックを検索し、get_doc_page で該当するページを読んでから、以下のガイダンスを適用してください。内容が異なる場合は、ドキュメントに従ってください。cloud_* ツールを使うと、このスキルに記載されている Capawesome Cloud の操作（アプリの作成、ビルドの開始、チャンネルやストアへのデプロイ、ロールバック、失敗したジョブの診断）を、Capawesome CLI の代わりに直接実行できます。
• 利用できない場合は、以下のコマンドでサーバーを追加できることを一度だけ伝えてから、このスキルの手順を続けてください。サーバーが利用できるようになるまで待つ必要はありません。

claude mcp add --transport http capawesome "https://mcp.capawesome.io/mcp"

ドキュメントツールの利用にアカウントやトークンは不要です。Capawesome Cloud ツールを含む完全なセットアップ手順については、capawesome-mcp スキルを参照してください。

手順

ステップ 1：CLI をインストールする

グローバルにインストールします。

npm install -g @capawesome/cli@latest

または、npx を使うとグローバルにインストールせずにコマンドを実行できます。

npx @capawesome/cli <command>

インストールを確認します。

npx @capawesome/cli doctor

doctor コマンドは、環境と CLI の診断情報を出力します。

ステップ 2：認証する

対話型ログイン（ローカル開発）

npx @capawesome/cli login

ブラウザーで認証フローが開きます。フローを完了すると、CLI はセッションをローカルに保存します。

トークンベースのログイン（CI/CD）

1. Capawesome Cloud Console の Settings > Tokens でトークンを生成します。
2. トークンを使って認証します。

npx @capawesome/cli login --token <TOKEN>

セッションを確認する

npx @capawesome/cli whoami

ログアウトする

npx @capawesome/cli logout

ステップ 3：アプリを作成または選択する

ユーザーがすでに Capawesome Cloud アプリ ID を持っている場合は、この手順をスキップします。

新しいアプリを作成します。

npx @capawesome/cli apps:create --name "My App" --organization-id <ORGANIZATION_ID>

CLI は app ID（UUID）を出力します。後続のコマンドで使用するために保存してください。

ステップ 4：プロジェクトをリンクする（任意）

アプリがリポジトリのルートにあり、npm install と npm run build を使用する標準的なプロジェクト構成の場合は、スキップしてください。

モノレポ、サブディレクトリ内のアプリ、またはカスタムビルドコマンドを使用する場合は、プロジェクトルートに capawesome.config.json を作成します。

{
  "cloud": {
    "apps": [
      {
        "appId": "<APP_ID>",
        "baseDir": "apps/my-app",
        "dependencyInstallCommand": "npm install",
        "webBuildCommand": "npm run build"
      }
    ]
  }
}

モノレポ、pnpm、Yarn の設定を含むすべての構成オプションについては、references/project-configuration.md を参照してください。

ステップ 5：CLI コマンドを実行する

カテゴリ別にまとめられたコマンドの全リファレンスについては、references/commands.md をお読みください。

• 認証 — login、logout、whoami
• アプリ管理 — apps:create、apps:delete、apps:get、apps:import、apps:list、apps:transfer、apps:link、apps:unlink
• ビルドコマンド — apps:builds:create、apps:builds:cancel、apps:builds:download、apps:builds:failure-summary、apps:builds:get、apps:builds:list、apps:builds:logs
• 証明書コマンド — apps:certificates:create、apps:certificates:list、apps:certificates:get、apps:certificates:update、apps:certificates:delete
• 環境コマンド — apps:environments:create、apps:environments:get、apps:environments:list、apps:environments:set、apps:environments:unset、apps:environments:delete
• チャネルコマンド — apps:channels:create、apps:channels:delete、apps:channels:get、apps:channels:list、apps:channels:pause、apps:channels:resume、apps:channels:update
• ライブアップデートコマンド — apps:liveupdates:create、apps:liveupdates:upload、apps:liveupdates:register、apps:liveupdates:bundle、apps:liveupdates:generatemanifest、apps:liveupdates:generatesigningkey、apps:liveupdates:rollback、apps:liveupdates:rollout、apps:liveupdates:setnativeversions
• デプロイコマンド — apps:deployments:create、apps:deployments:cancel、apps:deployments:failure-summary、apps:deployments:get、apps:deployments:list、apps:deployments:logs
• デスティネーションコマンド — apps:destinations:create、apps:destinations:list、apps:destinations:get、apps:destinations:update、apps:destinations:delete
• デバイスコマンド — apps:devices:delete、apps:devices:forcechannel、apps:devices:unforcechannel、apps:devices:probe
• 組織コマンド — organizations:create、organizations:get、organizations:list
• ユーティリティ — doctor
• 非推奨 — apps:bundles:*、manifests:generate（後方互換性のために保持されています）

ステップ 6：CI/CD 統合を設定する（任意）

CI/CD パイプラインで CLI コマンドを実行する場合を除き、この手順はスキップしてください。

以下を含む CI/CD の設定手順全体については、references/ci-cd-integration.md をお読みください。

• トークンベースの認証
• --detached を使用した非ブロッキングビルド
• --json を使用した機械可読形式の出力
• --yes を使用した確認プロンプトのスキップ
• GitHub Actions およびその他の CI プラットフォーム向けのワークフロー例

エラー処理

• command not found: @capawesome/cli — CLI がグローバルにインストールされていません。npm install -g @capawesome/cli@latest でインストールするか、コマンドの前に npx を付けてください。
• 認証エラー／Not authenticated — npx @capawesome/cli login を再実行してください。CI/CD の場合は、トークンが有効で期限切れでないことを確認してください。
• whoami が想定外のユーザーを返す — npx @capawesome/cli logout でログアウトし、正しいアカウントで再度ログインしてください。
• コマンドでオプションが不足しているというエラーが発生する — コマンドに --help を付けて実行し、必須および任意のフラグを確認してください。
• doctor で問題が報告される — 診断結果に従って、環境の問題（Node.js のバージョン、npm のバージョン、CLI のバージョン）を解決してください。
• capawesome.config.json が検出されない — ファイルがプロジェクトのルートディレクトリ（package.json と同じ階層）にあることを確認してください。JSON が有効であることも確認してください。

関連スキル

• capawesome-cloud — Capawesome Cloud の機能（ネイティブビルド、ライブアップデート、アプリストアへの公開）の設定と使用に関するスキルです。CLI をツールとして使用しますが、ワークフロー全体を扱います。
• capacitor-plugins — @capawesome/capacitor-live-update プラグインを含む、Capacitor プラグインのインストールと設定に関するスキルです。
• capawesome-mcp — MCP クライアントをホストされている Capawesome MCP サーバーに接続し、常に最新のドキュメントと Capawesome Cloud 管理機能を利用できます。