Alias: blitz i
Use this command to install a Blitz Recipe into your project.
Supports both official recipes and custom third-party recipes. Recipe names can be specified in any of the following formats:
blitz install
select and install from the list of official Blitz
recipes
blitz install official-recipe
for an official recipe from the Blitz
team
blitz install ./recipes/my-local-recipes.ts
for a locally-authored
recipe
blitz install github-user/my-published-recipe
for a custom recipe
hosted on GitHub
Also, you can pass arguments to recipe itself in the form of key=value
(if it accept them):
$ blitz install my-recipe key=value
For more information about recipes, see the official docs for installing recipes and writing your own.
Argument | Required | Description |
---|---|---|
name | No | The name of the recipe to install, a path to a local recipe, or a GitHub repository name |
Argument | Short | Description | Default |
---|---|---|---|
--yes | -y | Install the recipe automatically without user confirmation. | false |
> blitz install
? Select a recipe to install …
❯ base-web
bumbag-ui
chakra-ui
emotion
### and more
> blitz install tailwind
✅ Installed 2 dependencies
✅ Successfully created postcss.config.js, tailwind.config.js
✅ Successfully created app/styles/button.css, app/styles/index.css
✅ Modified 1 file: app/pages/_app.tsx
🎉 The recipe for Tailwind CSS completed successfully! Its functionality is now fully configured in your Blitz app.