コンテンツにスキップ

CLI

Cloudflareは、新しいWorkersおよびPagesプロジェクトを作成するためのCLIコマンドを提供しています — npm create cloudflare、これはcreate-cloudflareパッケージ ↗によって動かされています。

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

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

Terminal window
npm create cloudflare@latest

このコマンドを実行すると、create-cloudflare ↗パッケージをインストールするように促され、その後、作成したいアプリケーションのタイプに関する質問が表示されます。

ウェブフレームワーク

「Framework Starter」オプションを選択すると、使用するフレームワークを選択するように促されます。現在サポートされているフレームワークは以下の通りです：

フレームワークを使用すると、npm create cloudflareはフレームワーク自身のコマンドを直接使用して新しいプロジェクトを生成します。これにより、追加の質問が表示される場合があります。これにより、作成するプロジェクトがフレームワークの最新バージョンに対応しており、npm create cloudflareを使用してプロジェクトを作成する際に、フレームワークのツールを直接使用した場合と同じオプションがすべて利用可能になります。

デプロイ

プロジェクトの設定が完了すると、Cloudflareにプロジェクトをデプロイするかどうかを尋ねられます。これはオプションです。

デプロイを選択すると、Cloudflareアカウントにサインインするように求められ（まだサインインしていない場合）、プロジェクトがデプロイされます。

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

npm create cloudflareを使用して新しいプロジェクトを作成し、それをGithubまたはGitlabアカウントのGitリポジトリに接続するには、次の手順を実行します：

  1. npm create cloudflare@latestを実行し、希望のオプションを選択します。
  2. プロンプト「アプリケーションをデプロイしますか？」にはnoを選択します。これは重要です — yesを選択してターミナルからアプリケーションをデプロイすると、後でこのPagesプロジェクトをGitリポジトリに接続することはできません。新しいCloudflare Pagesプロジェクトを作成する必要があります。
  3. npm create cloudflare@latestが作成したアプリケーションを使用して、新しいGitリポジトリを作成します。
  4. Git統合ガイドに記載されている手順に従います。

CLI引数

C3は、一連のインタラクティブなプロンプトを通じて必要な入力を収集します。また、コマンドライン引数を指定することで、これらのプロンプトをスキップすることもできます。CIなどの非インタラクティブなコンテキストでC3を使用するには、コマンドラインを介してすべての必須引数を指定する必要があります。

これは、C3の呼び出しの完全な形式と可能なCLI引数です：

Terminal window
npm create cloudflare@latest [--] [<DIRECTORY>] [OPTIONS] [-- <NESTED ARGS...>]

  • DIRECTORY string optional

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

  • NESTED ARGS.. string[] optional

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

  • --category string optional

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

    • このオプションの可能な値は：

      • hello-world: Hello Worldの例
      • web-framework: フレームワークスターター
      • demo: アプリケーションスターター
      • remote-template: GitHubリポジトリからのテンプレート

  • --type string optional

    • 作成するアプリケーションのタイプ。

    • このオプションの可能な値は：

      • 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 optional

    • ウェブアプリケーションを作成するために使用するフレームワークのタイプ（このオプションを使用する場合、--typeは無視されます）。

    • このオプションの可能な値は：

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

  • --template string optional

    • 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 ドキュメント ↗を参照してください。

      最低限、テンプレートには以下が含まれている必要があります：

      • package.json
      • wrangler.toml
      • src/に、wrangler.tomlから参照されるワーカーのスクリプトが含まれていること

      このリポジトリのテンプレートフォルダ ↗に他の例があります。

  • --deploy boolean (default: true) optional

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

  • --lang string (default: ts) optional

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

    • このオプションの可能な値は：

      • ts
      • js
      • python

  • --ts boolean (default: true) optional

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

  • --git boolean (default: true) optional

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

  • --open boolean (default: true) optional

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

  • --existing-script string optional

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

    • --existing-scriptが指定されている場合、deployは無視されます。

  • -y, --accept-defaults boolean optional

    • すべてのデフォルトC3オプションを使用します。各オプションは指定することで上書きできます。

  • --auto-update boolean (default: true) optional

    • C3の最新バージョンを自動的に使用します。

  • -v, --version boolean optional

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

  • -h, --help boolean optional

    • ヘルプメッセージを表示します。
Cloudflare DashboardDiscordCommunityLearning CenterSupport Portal
Cookie Settings