← Cloudflare Pages / pages / get-started

C3 CLI

Cloudflare poskytuje příkaz CLI pro vytváření nových projektů Workers a Pages: npm create cloudflare, běžící na create-cloudflare balíček ↗.

Otevřete okno terminálu a spusťte:

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

Spuštění tohoto příkazu vás vyzve k instalaci create-cloudflare ↗ balíček a poté se vás zeptá na typ aplikace, kterou chcete vytvořit.

Pokud zvolíte možnost "Framework Starter", budete vyzváni k výběru frameworku, který chcete použít. Aktuálně jsou podporovány tyto frameworky:

• Angular
• Astro
• Docusaurus
• Gatsby
• Hono
• Statické exporty Next.js
• Nuxt
• Qwik
• React
• Redwood
• Remix
• SolidStart
• SvelteKit
• Vue

Pokud používáte framework, npm create cloudflare přímo používá vlastní příkaz frameworku pro vygenerování nového projektu, což si může vyžádat další otázky. Díky tomu je vytvořený projekt aktuální s nejnovější verzí frameworku a máte k dispozici stejné možnosti jako při vytváření projektu pomocí npm create cloudflare jako byste projekt vytvořili přímo pomocí nástrojů daného frameworku.

Jakmile je váš projekt nakonfigurovaný, budete dotázáni, zda chcete projekt nasadit do Cloudflare. Tento krok je volitelný.

Pokud se rozhodnete nasadit, budete vyzváni k přihlášení do svého účtu Cloudflare (pokud ještě nejste přihlášeni) a váš projekt bude nasazen.

Chcete-li vytvořit nový projekt pomocí npm create cloudflare, a poté jej propojte s repozitářem Git na vašem účtu Github nebo Gitlab, postupujte podle následujících kroků:

1. Spustit npm create cloudflare@latest, a zvolte požadované možnosti
2. Vyberte no na výzvu „Chcete nasadit svou aplikaci?“. To je důležité, pokud vyberete yes a nasaďte aplikaci z terminálu (Direct Upload), pak již později nebude možné tento projekt Pages připojit k repozitáři git. Budete muset vytvořit nový projekt Cloudflare Pages.
3. Vytvořte nový repozitář Git pomocí aplikace, kterou npm create cloudflare@latest bylo pro vás právě vytvořeno.
4. Postupujte podle kroků uvedených v Průvodce integrací Git

C3 shromažďuje veškeré potřebné vstupy prostřednictvím série interaktivních výzev. Své volby můžete zadat také pomocí argumentů příkazové řádky, čímž tyto výzvy přeskočíte. Pokud chcete C3 použít v neinteraktivním prostředí, například v CI, musíte všechny požadované argumenty zadat přes příkazovou řádku.

Toto je úplný formát volání C3 spolu s možnými argumenty CLI:

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

• DIRECTORY string volitelné

  • Adresář, ve kterém se má aplikace vytvořit. Název aplikace se odvozuje od názvu adresáře.

• NESTED ARGS.. string[] volitelné

  • Argumenty CLI, které se předají případným CLI nástrojům třetích stran, jež může C3 spustit (v případě fullstack aplikací).

• --category string volitelné

  • Druh šablon, které se mají vytvořit.

  • Možné hodnoty pro tuto možnost jsou:

    • hello-world: Příklad Hello World
    • web-framework: Framework Starter
    • demo: Application Starter
    • remote-template: Šablona z GitHub repozitáře

• --type string volitelné

  • Typ aplikace, která se má vytvořit.

  • Možné hodnoty pro tuto možnost jsou:

    • hello-world: Základní Cloudflare Worker „Hello World“.
    • hello-world-durable-object: Durable Object a Worker pro komunikaci s ním.
    • common: Cloudflare Worker, který implementuje typický příklad směrování/proxy funkcionality.
    • scheduled: Naplánovaný Cloudflare Worker (spouštěný přes Cron Triggers).
    • queues: Cloudflare Worker, který je zároveň konzumentem i producentem Queues.
    • openapi: Worker, který implementuje REST endpoint OpenAPI.
    • pre-existing: Načtěte Worker inicializovaný z Cloudflare dashboardu.

• --framework string volitelné

  • Typ frameworku použitý k vytvoření webové aplikace (při použití této možnosti, --type se ignoruje).

  • Možné hodnoty pro tuto možnost jsou:

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

• --template string volitelné

  • Vytvořte nový projekt pomocí externí šablony uložené v repozitáři Git

  • Hodnotu této možnosti lze zadat jedním z následujících způsobů:

    • user/repo
    • [email protected]:user/repo
    • https://github.com/user/repo
    • user/repo/some-template (podadresáře)
    • user/repo#canary (větve)
    • user/repo#1234abcd (hash commitu)
    • bitbucket:user/repo (BitBucket)
    • gitlab:user/repo (GitLab)

    Viz degit dokumentace ↗ pro další podrobnosti.

    Šablony musí přinejmenším obsahovat následující:

    • package.json
    • Konfigurační soubor Wrangler
    • src/ obsahující skript workeru, na který odkazuje konfigurační soubor Wrangler

    Viz složka šablon ↗ tohoto repozitáře, kde najdete další příklady.

• --deploy boolean (výchozí: true) volitelné

  • Nasaďte svou aplikaci po jejím vytvoření.

• --lang string (výchozí: ts) volitelné

  • Programovací jazyk šablony.

  • Možné hodnoty pro tuto možnost jsou:

    • ts
    • js
    • python

• --ts boolean (výchozí: true) volitelné

  • Používejte TypeScript ve své aplikaci. Zastaralé. Použijte --lang=ts místo toho.

• --git boolean (výchozí: true) volitelné

  • Inicializujte lokální git repozitář pro svou aplikaci.

• --open boolean (výchozí: true) volitelné

  • Otevřete nasazenou aplikaci ve svém prohlížeči (tato možnost se ignoruje, pokud aplikace není nasazená).

• --existing-script string volitelné

  • Název existujícího skriptu Cloudflare Workers, který se má lokálně naklonovat. Při použití této možnosti --type se vynuceně převede na pre-existing.

  • Když --existing-script je zadaný, deploy se bude ignorovat.

• -y, --accept-defaults boolean volitelné

  • Použijte všechny výchozí možnosti C3, každou z nich lze přitom přepsat jejím zadáním.

• --auto-update boolean (výchozí: true) volitelné

  • Automaticky používá nejnovější verzi C3.

• -v, --version boolean volitelné

  • Zobrazí číslo verze.

• -h, --help boolean volitelné

  • Zobrazí nápovědu.

Cloudflare shromažďuje anonymní údaje o používání, aby mohl zlepšovat create-cloudflare v průběhu času. Více se dozvíte v naší zásady zpracování dat ↗.

Pokud si nepřejete sdílet žádné informace, můžete se odhlásit.

npm create cloudflare@latest -- telemetry disable

Alternativně můžete nastavit proměnnou prostředí:

export CREATE_CLOUDFLARE_TELEMETRY_DISABLED=1

Stav sběru telemetrie můžete kdykoli zkontrolovat.

npm create cloudflare@latest -- telemetry status

Sběr telemetrie můžete kdykoli znovu povolit.

npm create cloudflare@latest -- telemetry enable