Seamlessly scaffold content-driven web projects with the power of QwikDev/Astro.
Whether you're building blazing-fast blogs, portfolios, or scalable applications,
this CLI has you covered.
Quickstart 🎉
Have an existing project?
If you already have an existing Astro project and want to add the integration,
you can do so with the following command:
npm create @qwikdev/astro@latest --add
Create a new project
To create a brand new project,
you can use the following command:
npm create @qwikdev/astro@latest
🚀 Installation & Usage
🧑💻 Usage
Run the following command using your preferred package manager:
bun create @qwikdev/astro [destination] [adapter] [...options]
🛠️ Flags
Arguments
Customize the command with the following arguments:
Name
Type
Default value
Description
destination
String
./qwik-astro-app
Directory of the project.
adapter
"deno" or "node" or "none"
none
Server adapter.
Options
Enhance your project setup with these additional flags:
Name
Shortcut
Description
--help
-h
Display all available options.
--template
-t
Use an Astro template.
--add / --no-add
-a / --no-a
Add QwikDev/astro to an existing project.
--force / --no-force
-f / --no-f
Overwrite target directory, if needed.
--copy / --no-copy
-c / --no-c
Copy files without overwriting.
--biome / --no-biome
Use Biome instead of ESLint/Prettier.
💡 Examples
The easiest way to explore QwikDev/Astro
on your machine is by running the following command:
npm create @qwikdev/astro@latest
Start Without Any Template
You can create a project with no template to keep it minimal
or customize it from scratch.
This approach uses only the default starter kit provided by the integration:
npm create @qwikdev/astro@latest my-project
To skip all prompts and initialize without a template automatically:
npm create @qwikdev/astro@latest my-project --yes
Add Qwik/Astro to an Existing Project**
If you already have an existing project
and want to integrate QwikDev/Astro without creating a new project,
you can use the --add option: