create-geastack 0.1.27 → 0.1.29

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.
Files changed (2) hide show
  1. package/README.md +60 -10
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @geastack/create-geastack
1
+ # create-geastack
2
2
 
3
3
  Project scaffolder for GeaStack apps. It is the `create-geastack` command
4
4
  behind `npm create geastack`.
@@ -6,24 +6,74 @@ behind `npm create geastack`.
6
6
  ```sh
7
7
  npm create geastack@latest my-app
8
8
  cd my-app
9
- npm install
10
- gea build --target web
9
+ npx gea setup
11
10
  ```
12
11
 
13
- The scaffolder offers the bundled counter starter, a blank application, and the
14
- GitHub-backed example gallery for web, embedded, GeaOS, iOS, macOS and Android
15
- apps. Every generated project carries a `.gea/boards.json` so `gea` can find
16
- its boards.
12
+ Run without options, it asks what you want to build: a blank application (for
13
+ the web browser, an ESP32 or RP2350 board, GeaOS, macOS, iOS, tvOS, Android or
14
+ Windows) or an application from the example gallery. The gallery lists the
15
+ bundled Component Counter first, then the GitHub examples for web, ESP32,
16
+ RP2350, GeaOS, iOS, macOS, Android and Windows. In an interactive terminal it
17
+ installs the npm dependencies; otherwise the closing line tells you to run
18
+ `npm install` first.
17
19
 
18
- Useful flags:
20
+ What comes next depends on what you created. The project's own `README.md`
21
+ lists its commands:
19
22
 
20
23
  ```sh
21
- npx create-geastack my-panel --dir ./my-panel --dry-run
24
+ # Web app: development server with HMR, then a static build
25
+ npx gea dev
26
+ npx gea build --target web
27
+
28
+ # Board app (the Component Counter is ESP32-only): register the board, then flash it
29
+ npx gea setup
30
+ npx gea flash --board <alias> --monitor
31
+ ```
32
+
33
+ `npx gea setup` registers the board and prints the exact `gea flash` line,
34
+ with `<alias>` being the name you give the board there.
35
+
36
+ Options:
37
+
38
+ ```sh
39
+ --starter counter|blank|example skip the first question
40
+ --example <example-id> gallery entry to copy (with --starter example)
41
+ --no-install do not run npm install
22
42
  ```
23
43
 
44
+ Automation options:
45
+
46
+ ```sh
47
+ --dir <path> directory to create (default: the app name)
48
+ --id <app-id> app id (default: derived from the name)
49
+ --name <display-name> display name
50
+ --examples-repo <git-url-or-local-path>
51
+ --examples-ref <git-ref>
52
+ --targets web,esp32,rp2350,geaos,macos,ios,tvos,android,windows
53
+ --core-dependency <specifier> version of @geastack/core to depend on
54
+ --cli-dependency <specifier> version of @geastack/cli to depend on
55
+ --install run npm install even without a terminal
56
+ --dry-run print the example fetch and npm install instead of running them
57
+ --yes answer every question with its default
58
+ --force write into a non-empty directory
59
+ ```
60
+
61
+ Without a terminal, or with `--yes`, the scaffolder creates the Component
62
+ Counter unless `--starter` says otherwise; `--starter example` then needs
63
+ `--example <id>`. For example:
64
+
65
+ ```sh
66
+ npx create-geastack my-web-app --starter blank --targets web
67
+ npx create-geastack watch-demo --starter example --example watch
68
+ ```
69
+
70
+ Every generated project carries a `.gea/boards.json`, so `gea setup` saves its
71
+ board aliases in the project.
72
+
24
73
  The package is a thin binary: it depends on `@geastack/cli` and calls its
25
74
  `create` entry point, so the same command is also available as `gea create`.
26
- See the `@geastack/cli` README for the full command reference.
75
+ See the `@geastack/cli` README for the full command reference. It needs
76
+ Node.js 22 or later.
27
77
 
28
78
  ## License
29
79
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "create-geastack",
3
- "version": "0.1.27",
3
+ "version": "0.1.29",
4
4
  "description": "Project scaffolder for GeaStack apps: `npx create-geastack my-app` or `npm create geastack my-app`.",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {
@@ -9,7 +9,7 @@
9
9
  "directory": "packages/create-geastack"
10
10
  },
11
11
  "engines": {
12
- "node": ">=20.19"
12
+ "node": ">=22"
13
13
  },
14
14
  "type": "module",
15
15
  "bin": {
@@ -22,6 +22,6 @@
22
22
  "access": "public"
23
23
  },
24
24
  "dependencies": {
25
- "@geastack/cli": "^0.1.108"
25
+ "@geastack/cli": "^0.1.117"
26
26
  }
27
27
  }