Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

C3 CLI

最終更新 Markdown で表示Agent セットアップ

Cloudflare は、新しい Workers および Pages プロジェクトを作成する CLI コマンド npm create cloudflare を提供しています。create-cloudflare パッケージ ↗ が裏側で動作します。

新しいアプリケーションを作成する

ターミナルを開き、次のコマンドを実行します。

npm create cloudflare@latest -- --platform=pages

このコマンドを実行すると、create-cloudflare ↗ パッケージのインストールを求められ、作成するアプリケーションの種類について質問されます。

Web フレームワーク

「Framework Starter」を選ぶと、使うフレームワークを尋ねられます。現在サポートしているフレームワークは次のとおりです。

フレームワークを使う場合、npm create cloudflare はフレームワーク自身のプロジェクト生成コマンドを直接使います。追加の質問が表示されることがあります。これにより、作成するプロジェクトはフレームワークの最新バージョンに追従し、フレームワークのツールで直接作成する場合と同じ選択肢を npm create cloudflare でも選べます。

デプロイ

プロジェクトの設定が終わると、Cloudflare へデプロイするかどうかを尋ねられます。これは任意です。

デプロイを選ぶと、Cloudflare アカウントへのサインインを求められ（まだの場合）、プロジェクトがデプロイされます。

Git リポジトリに接続した新しい Pages プロジェクトを作成する

npm create cloudflare で新しいプロジェクトを作成し、GitHub または GitLab アカウント上の Git リポジトリに接続するには、次の手順を実行します。

  1. npm create cloudflare@latest を実行し、希望のオプションを選びます。
  2. 「Do you want to deploy your application?」のプロンプトで no を選びます。ここが重要です。yes を選んでターミナルからアプリケーションをデプロイ（Direct Upload）すると、あとからこの Pages プロジェクトを Git リポジトリに接続できません。新しい Cloudflare Pages プロジェクトを作成する必要があります。
  3. npm create cloudflare@latest が作成したアプリケーションを使って、新しい Git リポジトリを作成します。
  4. Git 連携ガイド の手順に従います。

CLI 引数

C3 は、対話型プロンプトで必要な入力を集めます。コマンドライン引数で選択内容を指定することもでき、その場合はプロンプトをスキップします。CI などの非対話環境で C3 を使う場合は、必要な引数をすべてコマンドラインで指定する必要があります。

C3 の呼び出し形式と、使える CLI 引数は次のとおりです。

npm create cloudflare@latest -- --platform=pages [<DIRECTORY>] [OPTIONS] [-- <NESTED ARGS...>]

  • DIRECTORY string 任意

    • アプリケーションを作成するディレクトリです。アプリケーション名はディレクトリ名から取得します。

  • NESTED ARGS.. string[] 任意

    • C3 が呼び出すサードパーティ CLI に渡す CLI 引数です（フルスタックアプリケーションの場合）。

  • --category string 任意

    • 作成するテンプレートの種類です。

    • このオプションの値は次のとおりです。

      • hello-world: Hello World の例
      • web-framework: Framework Starter
      • demo: Application Starter
      • remote-template: GitHub リポジトリのテンプレート

  • --type string 任意

    • 作成するアプリケーションの種類です。

    • このオプションの値は次のとおりです。

      • hello-world: 基本的な "Hello World" Cloudflare Worker です。
      • hello-world-durable-object: Durable Object と、それと通信する Worker です。
      • common: ルーティング／プロキシの一般的な例を実装した Cloudflare Worker です。
      • scheduled: スケジュール実行される Cloudflare Worker です（Cron Triggers で起動します）。
      • queues: Queues のコンシューマーとプロデューサーの両方である Cloudflare Worker です。
      • openapi: OpenAPI REST エンドポイントを実装した Worker です。
      • pre-existing: Cloudflare ダッシュボードで初期化した Worker を取得します。

  • --framework string 任意

    • Web アプリケーションを作成するときに使うフレームワークです（このオプションを使うと --type は無視されます）。

    • このオプションの値は次のとおりです。

      • angular
      • astro
      • docusaurus
      • gatsby
      • hono
      • next
      • nuxt
      • qwik
      • react
      • redwood
      • remix
      • solid
      • svelte
      • vue

  • --template string 任意

    • Git リポジトリ上の外部テンプレートから新しいプロジェクトを作成します。

    • このオプションの値は、次のいずれかの形式で指定できます。

      • user/repo
      • git@github.com:user/repo
      • https://github.com/user/repo
      • user/repo/some-template（サブディレクトリ）
      • user/repo#canary（ブランチ）
      • user/repo#1234abcd（コミットハッシュ）
      • bitbucket:user/repo（BitBucket）
      • gitlab:user/repo（GitLab）

      詳細は degit の ドキュメント ↗ を参照してください。

      テンプレートには、少なくとも次の内容が必要です。

      その他の例は、このリポジトリの templates フォルダー ↗ を参照してください。

  • --deploy boolean (デフォルト: true) 任意

    • 作成後にアプリケーションをデプロイします。

  • --lang string (デフォルト: ts) 任意

    • テンプレートのプログラミング言語です。

    • このオプションの値は次のとおりです。

      • ts
      • js
      • python

  • --ts boolean (デフォルト: true) 任意

    • アプリケーションで TypeScript を使います。非推奨です。代わりに --lang=ts を使ってください。

  • --git boolean (デフォルト: true) 任意

    • アプリケーション用のローカル Git リポジトリを初期化します。

  • --open boolean (デフォルト: true) 任意

    • デプロイしたアプリケーションをブラウザーで開きます（デプロイしていない場合、このオプションは無視されます）。

  • --existing-script string 任意

    • ローカルにクローンする既存の Cloudflare Workers スクリプト名です。このオプションを使うと、--type は pre-existing に強制されます。

    • --existing-script を指定すると、deploy は無視されます。

  • -y, --accept-defaults boolean 任意

    • すべてのデフォルトの C3 オプションを使います。個別に指定して上書きすることもできます。

  • --auto-update boolean (デフォルト: true) 任意

    • 常に最新バージョンの C3 を使います。

  • -v, --version boolean 任意

    • バージョン番号を表示します。

  • -h, --help boolean 任意

    • ヘルプメッセージを表示します。

テレメトリ

Cloudflare は、create-cloudflare の改善のため、匿名の利用データを収集します。詳細は データポリシー ↗ を参照してください。

情報を共有したくない場合は、オプトアウトできます。

npm create cloudflare@latest -- telemetry disable

代わりに、環境変数を設定することもできます。

export CREATE_CLOUDFLARE_TELEMETRY_DISABLED=1

テレメトリ収集の状態は、いつでも確認できます。

npm create cloudflare@latest -- telemetry status

テレメトリ収集は、いつでも再有効化できます。

npm create cloudflare@latest -- telemetry enable

役に立ちましたか？