mcpField
C
cloudcannon-cli

cloudcannon-cli

github.com/cloudcannonクラウド・DevOps975 回インストール2 日前に更新
リポジトリ

cloudcannon-cli について

ローカル設定作業と、CloudCannon のホストサイト操作を扱う `@cloudcannon/cli` のスキルです。認証不要のローカルコマンドと API 経由のリモートコマンドを区別し、ライブサイトへの書き込み前に確認を求めます。

主な機能

  1. 01コマンドとフラグの調べ方
  2. 02ローカル設定の生成と検証
  3. 03ホストサイトと組織の管理
  4. 04ファイル編集、コミット、ビルド、ログ確認
  5. 05認証と CI のセットアップ

活用シーン

  1. 01サイト設定の生成と検証
  2. 02ホストサイトのファイルの確認や変更
  3. 03ビルドの実行とログの確認
  4. 04フォーム送信の一覧表示

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/cloudcannon/agent-skills --skill cloudcannon-cli

インストール後、Claude Code で/cloudcannon-cliを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

authentication.md
commands.md
editing-sessions.md
troubleshooting.md

詳細

The CloudCannon CLI

@cloudcannon/cli はローカルとリモートの2つの部分で構成されています。ローカル側は作業ディレクトリ内のファイルを読み書きし、アカウントは不要です。リモート側は CloudCannon API と通信し、認証情報が必要で、公開中のサイトに対して操作します。

使用する場面

  • タスクに対応するコマンドがあるか、そのフラグは何かを調べる
  • 認証する、または CI で CLI を設定する
  • サイトや組織を一覧表示、調査、作成する
  • ホスティングされたサイト上のファイルを読み取る、変更する、または変更をコミットする
  • 再ビルドを実行する、またはビルドや同期のログを読み取る
  • 既存サイトのビルド設定を変更する
  • フォーム送信を一覧表示する

使用しない場面

  • cloudcannon.config.yml に何を記述するか決める場合 — それは cloudcannon-configuration の担当です。このスキルでは configure と validate を実行しますが、それらの出力内容はそちらのスキルが扱います。
  • CloudCannon でサイトをローカル実行する場合 — cloudcannon dev については、再ビルドループや /__api の機能を含め、cloudcannon-dev-server で一貫して扱います。
  • コードから CloudCannon API を呼び出す場合 — それは cloudcannon-sdk の担当です。また、コマンドでは扱えない機能、DAM、バックアップ、同期履歴とプル、サイトスキャン、スクリーンショット、プロバイダー接続、site.copy、site.delete もそちらのスキルが扱います。
  • 編集可能な領域やスニペットを作成する場合 — cloudcannon-visual-editing と cloudcannon-snippets を参照してください。

最も重要なルール

ホスティングされたサイトに書き込むコマンドを実行する前に、必ずユーザーに確認してください。

理由： リモート側はサンドボックスではありません。sites files commit はサイトの実際の git リポジトリにプッシュし、sites rebuild は実際のビルドを開始し、sites update-build-config は今後のすべてのビルドの実行方法を変更します。これらのコマンドは確認を求めず、同じコマンドを再実行しても元には戻りません。

読み取り専用のリモートコマンド、つまりすべての list、すべての get、すべての print-* は、確認なしで実行しても安全です。

ローカルとリモート

区分コマンド認証情報対象
ローカルconfigure detect-*, configure generate, validate不要作業ディレクトリ内のファイル
ローカルdev不要ビルド済みの出力ディレクトリ
リモートorgs, sites, builds, inboxes, login/logout必要API 経由で操作する公開中のサイト

コマンドが読み取りのみだからといって、ローカルのコマンドだと決めつけてはいけません。 sites files get は読み取りコマンドですが、API 経由でホスティングされたサイトから読み取ります。

要件

Node 24 以降（現行の LTS）が必要です。npm i -g @cloudcannon/cli でグローバルにインストールするか、npx @cloudcannon/cli <command> で実行してください。

クイックスタート

# What commands exist, and what flags does one take
npx @cloudcannon/cli --help
npx @cloudcannon/cli sites files commit --help

# Local: generate and check a configuration
npx @cloudcannon/cli configure generate --auto --initial-site-settings
npx @cloudcannon/cli validate

# Remote: authenticate, then read
npx @cloudcannon/cli login
npx @cloudcannon/cli sites list

目次

ファイル内容
SKILL.md（このファイル）振り分け、ローカルとリモートの違い、公開中サイトに関するルール
commands.mdコマンドの全機能と、正確なフラグを documentation.json で照会する方法
authentication.md認証情報の方法と優先順位、保存場所、CI の設定
editing-sessions.mdsites files — 変更のステージングモデル、コミット、破棄
troubleshooting.md症状 → 原因 → 対処

よくある間違い

思い込み実際
「このコマンドのフラグは記憶を頼りに書き出せばよい。」フラグはリリースごとに変わります。documentation.json を参照するか、--help を実行してください。commands.md をご覧ください。
「ビルド設定はダッシュボードでしか変更できない。」sites update-build-config を使うと、既存のサイトの設定を変更できます。commands.md § Changing build configuration をご覧ください。
「ファイルをアップロードしたので、サイトに反映されている。」アップロード先は編集セッションであり、リポジトリではありません。コミットするまで公開されません。editing-sessions.md をご覧ください。
「コマンドが何も表示しなかったので、失敗した。」読み取りコマンドは標準出力に JSON のみを出力します。結果が空の場合は空の配列であり、エラーではありません。終了コードを確認してください。
「--site には UUID が必要だ。」名前、ID、UUID、またはドメインを指定できます。

コメント

Markdown 対応