# create-petal

> A CLI utility to create a new Petal app

Latest version **6.0.0** (published 2025-02-14) · (LicenseRef-OQL-1.2 OR MIT OR Apache-2.0) license · 0 weekly downloads

## Install

```sh
npm install create-petal
pnpm add create-petal
yarn add create-petal
bun add create-petal
```

Provides the command `create-petal`.

## Health

**Score 40/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities; has provenance.

Warnings: low downloads.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 6.0.0 |
| Published | 2025-02-14 |
| First published | 2023-10-29 |
| Weekly downloads | 0 |
| License | (LicenseRef-OQL-1.2 OR MIT OR Apache-2.0) |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=22 |
| Dependencies | 2 |
| Unpacked size | 18 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 2 |
| Author | @flowr |
| Maintainers | pauliesnug |
| Keywords | create-app, petal, tooling, build, create-petal, flowr |

## Links

- npm: https://www.npmjs.com/package/create-petal
- Repository: https://github.com/pulseflow/petal
- Homepage: https://petal.dyn.gay
- Issues: https://github.com/pulseflow/petal/issues
- Funding: https://ko-fi.com/pauliesnug
- npm.io page: https://npm.io/package/create-petal

## Dependencies (2)

- [giget](https://npm.io/package/giget.md) ^1.2.4
- [@astrojs/cli-kit](https://npm.io/package/@astrojs/cli-kit.md) ^0.4.1

## Alternatives

- [raw-loader](https://npm.io/package/raw-loader.md) — 4.3M weekly downloads
- [plop](https://npm.io/package/plop.md) — 1.4M weekly downloads
- [webpack-deadcode-plugin](https://npm.io/package/webpack-deadcode-plugin.md) — 80.3K weekly downloads
- [@storybook/preact-vite](https://npm.io/package/@storybook/preact-vite.md) — 54.2K weekly downloads
- [vite-plugin-transform](https://npm.io/package/vite-plugin-transform.md) — 2.4K weekly downloads

## Recent versions

- 6.0.0 (latest) — 2025-02-14
- 2.1.1-alpha.22 (canary) — 2024-01-20
- 5.3.0 — 2025-02-13
- 5.2.0 — 2025-01-21
- 5.1.0 — 2025-01-10
- 5.0.0 — 2024-12-08
- 4.4.1 — 2024-09-29
- 4.4.0 — 2024-09-26
- 4.3.6 — 2024-09-22
- 4.3.4 — 2024-09-16
- 4.3.3 — 2024-09-16
- 4.3.1 — 2024-09-14
- 4.3.0 — 2024-09-12
- 4.2.0 — 2024-09-10
- 4.1.0 — 2024-09-06
- … 61 more at https://npm.io/package/create-petal/versions

## README

# create-petal

work in progress

## scaffolding for petal projects

**with npm:**

```bash
npm create petal@latest
```

**with yarn:**

```bash
yarn create petal
```

**\*with pnpm:**

```bash
pnpm create petal
```

**with bun:**

```bash
bun create petal
```

`create-petal` automatically runs in _interactive_ mode, but you can also specify your project name and template with command line arguments.

```bash
# npm
npm create petal@latest my-petal-project -- --template minimal

# yarn
yarn create petal my-petal-project --template minimal

# pnpm
pnpm create petal my-petal-project --template minimal

# bun
bun create petal my-petal-project --template minimal
```

---
_Source: https://npm.io/package/create-petal · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._