create-weavekit-app 0.1.0 → 0.1.1
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 +50 -19
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,19 +1,50 @@
|
|
|
1
|
-
# create-weavekit-app
|
|
2
|
-
|
|
3
|
-
Scaffold a new WeaveKit project interactively.
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
1
|
+
# create-weavekit-app
|
|
2
|
+
|
|
3
|
+
> Scaffold a new WeaveKit project interactively.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm create weavekit-app my-app -- --type=agent
|
|
9
|
+
cd my-app
|
|
10
|
+
cp .env.example .env # set DATABASE_URL
|
|
11
|
+
weave migrate # schema.json → PostgreSQL tables
|
|
12
|
+
weave dev # http://localhost:3000
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Or run it directly:
|
|
16
|
+
|
|
17
|
+
```sh
|
|
18
|
+
npx create-weavekit-app my-app --type=agent
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Options
|
|
22
|
+
|
|
23
|
+
| Option | Description |
|
|
24
|
+
| --- | --- |
|
|
25
|
+
| `<name>` | Project directory name (required) |
|
|
26
|
+
| `--type` | Starting preset: `agent` (default), `governance`, `service`, `business` |
|
|
27
|
+
| `--yes` | Accept all defaults (a name is still required) |
|
|
28
|
+
| `--no-git` | Skip `git init` |
|
|
29
|
+
| `--force` | Scaffold into a non-empty directory |
|
|
30
|
+
|
|
31
|
+
## What it generates
|
|
32
|
+
|
|
33
|
+
A runnable project containing:
|
|
34
|
+
|
|
35
|
+
- `weavekit.config.ts` — the engine wiring (`satisfies EngineConfig`)
|
|
36
|
+
- `objects/leads/schema.json` — an example object with a small RBAC demo
|
|
37
|
+
- `main.ts` — the server entry (`createEngine` + `app.listen`)
|
|
38
|
+
- `.env.example` — placeholder for `DATABASE_URL`
|
|
39
|
+
- an optional `git init`
|
|
40
|
+
|
|
41
|
+
All project operations go through the `weave` CLI, which ships with
|
|
42
|
+
[`@weave-kit/engine`](https://github.com/weavekit/engine).
|
|
43
|
+
|
|
44
|
+
## Requirements
|
|
45
|
+
|
|
46
|
+
- Node.js 24 LTS
|
|
47
|
+
|
|
48
|
+
## License
|
|
49
|
+
|
|
50
|
+
[MIT](LICENSE)
|