← Cloudflare Pages / pages / get-started

C3 CLI

Cloudflare предоставляет команду CLI для создания новых проектов Workers и Pages: npm create cloudflare, на основе create-cloudflare пакет ↗.

Откройте окно терминала и выполните:

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

При выполнении этой команды вам будет предложено установить create-cloudflare ↗ пакет, а затем задаст вам вопросы о типе приложения, которое вы хотите создать.

Если вы выберете опцию "Framework Starter", вам будет предложено выбрать используемый фреймворк. В настоящее время поддерживаются следующие фреймворки:

• Angular
• Astro
• Docusaurus
• Gatsby
• Hono
• Статические экспорты Next.js
• Nuxt
• Qwik
• React
• Redwood
• Remix
• SolidStart
• SvelteKit
• Vue

При использовании фреймворка npm create cloudflare напрямую использует собственную команду фреймворка для создания нового проекта, что может сопровождаться дополнительными вопросами. Это гарантирует, что созданный проект будет соответствовать последней версии фреймворка и что у вас будут доступны все те же параметры, что и при создании проекта через npm create cloudflare как если бы вы создавали проект с помощью инструментов фреймворка напрямую.

После настройки проекта вам будет предложено развернуть его в Cloudflare. Это необязательно.

Если вы решите выполнить развертывание, вам будет предложено войти в аккаунт Cloudflare (если вы еще не вошли), и ваш проект будет развернут.

Чтобы создать новый проект с помощью npm create cloudflare, а затем подключить его к репозиторию Git в вашем аккаунте Github или Gitlab, выполните следующие шаги:

1. Запустите npm create cloudflare@latest, и выберите нужные параметры
2. Выберите no на запрос "Хотите развернуть приложение?". Это важно: если вы выберете yes и разверните приложение из терминала (Direct Upload), то в дальнейшем подключить этот проект Pages к репозиторию git будет невозможно. Вам придётся создать новый проект Cloudflare Pages.
3. Создайте новый git репозиторий с помощью приложения, которое npm create cloudflare@latest только что созданный для вас.
4. Выполните шаги, описанные в Руководство по интеграции с Git

C3 собирает все необходимые данные через серию интерактивных запросов. Также можно задать нужные значения через аргументы командной строки, что позволит пропустить эти запросы. Для использования C3 в неинтерактивном режиме, например в CI, необходимо указать все обязательные аргументы через командную строку.

Это полный формат вызова C3 вместе с возможными аргументами CLI:

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

• DIRECTORY string необязательно

  • Каталог, в котором должно быть создано приложение. Имя приложения берётся из имени каталога.

• NESTED ARGS.. string[] необязательно

  • Аргументы CLI, которые передаются сторонним CLI, вызываемым C3 (в случае full-stack приложений).

• --category string необязательно

  • Тип шаблонов, которые следует создать.

  • Возможные значения этого параметра:

    • hello-world: Пример Hello World
    • web-framework: Стартовый шаблон фреймворка
    • demo: Стартовый шаблон приложения
    • remote-template: Шаблон из репозитория GitHub

• --type string необязательно

  • Тип приложения, которое нужно создать.

  • Возможные значения этого параметра:

    • hello-world: Базовый Cloudflare Worker "Hello World".
    • hello-world-durable-object: Durable Object и Worker для взаимодействия с ним.
    • common: Cloudflare Worker, реализующий типичный пример функциональности маршрутизации и проксирования.
    • scheduled: Cloudflare Worker по расписанию (запускается через Cron Triggers).
    • queues: Cloudflare Worker, который является одновременно потребителем и производителем Queues.
    • openapi: Worker, реализующий OpenAPI REST эндпоинт.
    • pre-existing: Получите Worker, инициализированный из панели управления Cloudflare.

• --framework string необязательно

  • Тип фреймворка для создания веб-приложения (при использовании этого параметра --type игнорируется).

  • Возможные значения этого параметра:

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

• --template string необязательно

  • Создайте новый проект с помощью внешнего шаблона, размещённого в git репозитории

  • Значение этого параметра можно задать одним из следующих способов:

    • user/repo
    • [email protected]: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
    • src/ содержащий скрипт worker, на который есть ссылка в файле конфигурации Wrangler

    См. папка 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