@flaredev/cli 0.5.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,47 +1,55 @@
1
- # @flaredev/cli
2
-
3
- The `flare` command for [Flare](https://flare-docs.codetotech.com), a
4
- batteries-included fullstack framework on Cloudflare Workers (vinext, D1,
5
- Drizzle, Better Auth, R2). It scaffolds apps, generates resources with an admin
6
- dashboard and REST API, runs migrations and deploys.
7
-
8
- ## Install
9
-
10
- ```sh
11
- npm install -g @flaredev/cli # or: pnpm add -g @flaredev/cli
12
- ```
13
-
14
- Or with the install scripts (they check for Node.js 22+ and use npm or pnpm):
15
-
16
- ```sh
17
- # macOS / Linux
18
- curl -fsSL https://flare-docs.codetotech.com/install.sh | bash
19
- ```
20
-
21
- ```powershell
22
- # Windows PowerShell
23
- irm https://flare-docs.codetotech.com/install.ps1 | iex
24
- ```
25
-
26
- Or skip the install entirely:
27
-
28
- ```sh
29
- npm create flare-framework@latest my-app
30
- npx @flaredev/cli create my-app
31
- ```
32
-
33
- ## Use
34
-
35
- ```sh
36
- flare create shop
37
- cd shop
38
- flare gen resource Product --fields 'name:string, price:int, sku:string!'
39
- flare migrate
40
- flare dev
41
- flare deploy
42
- ```
43
-
44
- Run `flare --help` for every command, or read the
45
- [CLI reference](https://flare-docs.codetotech.com/reference/cli/).
46
-
47
- Requires Node.js 22 or later.
1
+ # @flaredev/cli
2
+
3
+ The `flare` command for [Flare](https://flare-docs.codetotech.com), a
4
+ batteries-included fullstack framework. It scaffolds apps, generates resources
5
+ with an admin dashboard and REST API, runs migrations and deploys.
6
+
7
+ Apps run on one of two stacks, chosen once at `flare create`:
8
+
9
+ - **Cloudflare** — vinext on Workers, D1 and Drizzle, Better Auth, R2.
10
+ - **Next.js** — Next.js 16 on Vercel, Postgres and Prisma, Better Auth, R2.
11
+
12
+ The descriptors, validators, policies, REST API and dashboard are the same on
13
+ both. [Choosing a stack](https://flare-docs.codetotech.com/start/stacks/) is the
14
+ comparison, including what each one can't do.
15
+
16
+ ## Install
17
+
18
+ ```sh
19
+ npm install -g @flaredev/cli # or: pnpm add -g @flaredev/cli
20
+ ```
21
+
22
+ Or with the install scripts (they check for Node.js 22+ and use npm or pnpm):
23
+
24
+ ```sh
25
+ # macOS / Linux
26
+ curl -fsSL https://flare-docs.codetotech.com/install.sh | bash
27
+ ```
28
+
29
+ ```powershell
30
+ # Windows PowerShell
31
+ irm https://flare-docs.codetotech.com/install.ps1 | iex
32
+ ```
33
+
34
+ Or skip the install entirely:
35
+
36
+ ```sh
37
+ npm create flare-framework@latest my-app
38
+ npx @flaredev/cli create my-app
39
+ ```
40
+
41
+ ## Use
42
+
43
+ ```sh
44
+ flare create shop
45
+ cd shop
46
+ flare gen resource Product --fields 'name:string, price:int, sku:string!'
47
+ flare migrate
48
+ flare dev
49
+ flare deploy
50
+ ```
51
+
52
+ Run `flare --help` for every command, or read the
53
+ [CLI reference](https://flare-docs.codetotech.com/reference/cli/).
54
+
55
+ Requires Node.js 22 or later.