https://github.com/yuhanawa/create-astro-theme
npm create astro-theme@latest
https://github.com/yuhanawa/create-astro-theme
astro astro-theme create-astro-theme
Last synced: 4 months ago
JSON representation
npm create astro-theme@latest
- Host: GitHub
- URL: https://github.com/yuhanawa/create-astro-theme
- Owner: Yuhanawa
- License: mit
- Created: 2024-12-07T15:35:59.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-10-25T20:11:24.000Z (8 months ago)
- Last Synced: 2025-11-23T23:03:47.636Z (7 months ago)
- Topics: astro, astro-theme, create-astro-theme
- Language: TypeScript
- Homepage:
- Size: 457 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# create-astro-theme
[](https://www.npmjs.com/package/create-astro-theme)
A CLI tool for creating and using themes with `astro-theme-provider`.
## Prerequisites
Currently, this tool only supports `pnpm`. Support for `npm` is planned for the future.
## Usage
You can use `create-astro-theme` with `pnpm`:
```bash
# With pnpm
pnpm create astro-theme@latest
```
This will start an interactive prompt that will guide you through the process.
### Commands
`create-astro-theme` has two main commands: `use` and `create`.
#### `use`
The `use` command helps you use an existing Astro theme in a new project.
```bash
pnpm create astro-theme@latest use
```
This will create a new project that uses the specified theme.
**Options:**
| Option | Description |
| --------------- | ---------------------------------------------------------- |
| `--dry-run` | Show what would be done without actually making changes. |
| `--verbose` | Show more detailed output. |
| `--skip` | Use recommended or default settings and skip prompts. |
| `--project-name`| Specify the project name. |
#### `create`
The `create` command helps you create a new Astro theme.
```bash
pnpm create astro-theme@latest create
```
This will create a new directory with the specified theme name, containing a new Astro theme project.
**Options:**
| Option | Description |
| --------------- | ---------------------------------------------------------- |
| `--dry-run` | Show what would be done without actually making changes. |
| `--verbose` | Show more detailed output. |
| `--skip` | Use recommended or default settings and skip prompts. |
| `--project-name`| Specify the project name (defaults to ``). |
| `--theme-name` | Specify the theme name (defaults to ``). |
## Contributing
Contributions are welcome! Please open an issue or submit a pull request on our [GitHub repository](https://github.com/Yuhanawa/create-astro-theme).
## License
This project is licensed under the [MIT License](LICENSE).