You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
remove Application Starter option in C3 experimental menu (#8395)
* fix: remove categories in C3 that have no templates
The `Application Starter` category doesn't contain any entries in experimental mode so we shouldn't show it.
This change updates C3 to automatically exclude categories that have no templates.
* remove incorrect caregory and fix e2e snapshots
* update another snapshot
* skip arrows + enter e2e test in experimental mode
* remove qwik from snapshot
* update allowed values in snapshot
* update test
* update missing starter -> example
* update missing Starter to example
---------
Co-authored-by: Pete Bacon Darwin <[email protected]>
The create-cloudflare cli (also known as C3) is a command-line tool designed to help you set up and deploy new applications to Cloudflare. In addition to speed, it leverages officially developed templates for Workers and framework-specific setup guides to ensure each new application that you set up follows Cloudflare and any third-party best practices for deployment on the Cloudflare network.
457
+
USAGE
458
+
<USAGE>
459
+
OPTIONS
460
+
You have selected experimental mode - the options below are filtered to those that support experimental mode.
461
+
directory
462
+
The directory where the application should be created. Also used as the name of the application.
463
+
If a path is provided that includes intermediary directories, only the base name will be used as the name of the application.
464
+
--category=<value>
465
+
Specifies the kind of templates that should be created
466
+
Allowed Values:
467
+
web-framework
468
+
Framework Starter
469
+
--type=<value>, -t
470
+
When using a built-in template, specifies the type of application that should be created.
471
+
Note that "--category" and "--template" are mutually exclusive options. If both are provided, "--category" will be used.
472
+
--framework=<value>, -f
473
+
The type of framework to use to create a web application (when using this option "--category" is coerced to "web-framework")
474
+
When using the --framework option, C3 will dispatch to the official creation tool used by the framework (ex. "create-remix" is used for Remix).
475
+
You may specify additional arguments to be passed directly to these underlying tools by adding them after a "--" argument, like so:
476
+
npm create cloudflare -- --framework next -- --ts
477
+
pnpm create cloudflare --framework next -- --ts
478
+
Allowed Values:
479
+
next, solid
480
+
--platform=<value>
481
+
Whether the application should be deployed to Pages or Workers. This is only applicable for Frameworks templates that support both Pages and Workers.
482
+
Allowed Values:
483
+
pages
484
+
Create a web application that can be deployed to Pages.
485
+
workers
486
+
Create a web application that can be deployed to Workers (BETA).
487
+
--lang=<value>
488
+
The programming language of the template
489
+
Allowed Values:
490
+
ts, js, python
491
+
--deploy, --no-deploy
492
+
Deploy your application after it has been created
493
+
--git, --no-git
494
+
Initialize a local git repository for your application
495
+
--open, --no-open
496
+
Opens the deployed application in your browser (this option is ignored if the application is not deployed)
497
+
--existing-script=<value>
498
+
The name of an existing Cloudflare Workers script to clone locally (when using this option "--type" is coerced to "pre-existing").
499
+
When "--existing-script" is specified, "deploy" will be ignored.
500
+
--template=<value>
501
+
An external template to be used when creating your project.
502
+
Any "degit" compatible string may be specified. For example:
The create-cloudflare cli (also known as C3) is a command-line tool designed to help you set up and deploy new applications to Cloudflare. In addition to speed, it leverages officially developed templates for Workers and framework-specific setup guides to ensure each new application that you set up follows Cloudflare and any third-party best practices for deployment on the Cloudflare network.
521
+
USAGE
522
+
<USAGE>
523
+
OPTIONS
524
+
directory
525
+
The directory where the application should be created. Also used as the name of the application.
526
+
If a path is provided that includes intermediary directories, only the base name will be used as the name of the application.
527
+
--category=<value>
528
+
Specifies the kind of templates that should be created
529
+
Allowed Values:
530
+
hello-world
531
+
Hello World Starter
532
+
web-framework
533
+
Framework Starter
534
+
demo
535
+
Application Starter
536
+
remote-template
537
+
Template from a GitHub repo
538
+
--type=<value>, -t
539
+
When using a built-in template, specifies the type of application that should be created.
540
+
Note that "--category" and "--template" are mutually exclusive options. If both are provided, "--category" will be used.
541
+
Allowed Values:
542
+
hello-world
543
+
For processing requests, transforming responses, or API endpoints
544
+
hello-world-assets-only
545
+
For static sites (including SPAs) or when using your own backend
546
+
hello-world-with-assets
547
+
For static sites with an API or server-side rendering (SSR)
548
+
hello-world-durable-object
549
+
For multiplayer apps using WebSockets, or when you need synchronization
550
+
hello-world-durable-object-with-assets
551
+
For full-stack applications requiring static assets, an API, and real-time coordination
552
+
common
553
+
Create a Worker to route and forward requests to other services
554
+
scheduled
555
+
Create a Worker to be executed on a schedule for periodic (cron) jobs
556
+
queues
557
+
Get started with a Worker that processes background tasks and message batches with Cloudflare Queues
558
+
openapi
559
+
Get started building a basic API on Workers
560
+
pre-existing
561
+
Fetch a Worker initialized from the Cloudflare dashboard.
562
+
--framework=<value>, -f
563
+
The type of framework to use to create a web application (when using this option "--category" is coerced to "web-framework")
564
+
When using the --framework option, C3 will dispatch to the official creation tool used by the framework (ex. "create-remix" is used for Remix).
565
+
You may specify additional arguments to be passed directly to these underlying tools by adding them after a "--" argument, like so:
0 commit comments