@appweaver/cli 1.5.0 → 1.5.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.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/skill/references/cli.md +34 -20
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@appweaver/cli",
3
- "version": "1.5.0",
3
+ "version": "1.5.1",
4
4
  "description": "Appweaver - the backend framework for AI-first development (@cli)",
5
5
  "author": "Luka Matosevic",
6
6
  "license": "MIT",
package/skill/references/cli.md CHANGED
@@ -46,10 +46,13 @@ weaver openapi|oa [options]
46
46
 
47
47
  Generate application OpenAPI specification schema.
48
48
 
49
- | Option | Description | Default |
50
- |---------------------------|------------------------------------------------------------------|-----------------|
51
- | `-o, --outputPath [path]` | Output path for generated OpenAPI specification | `./schema.json` |
52
- | `-f, --format [format]` | Output format for generated OpenAPI specification (json or yaml) | `json` |
49
+ | Option | Description | Default |
50
+ |---------------------------|------------------------------------------------------------------|------------------|
51
+ | `-o, --outputPath [path]` | Output path for generated OpenAPI specification | `./openapi.json` |
52
+ | `-f, --format [format]` | Output format for generated OpenAPI specification (json or yaml) | `json` |
53
+
54
+ When `--format yaml` is used and `--outputPath` is left at its default, the output path becomes `./openapi.yaml`.
55
+ Missing output directories are created automatically.
53
56
 
54
57
  ---
55
58
 
@@ -80,9 +83,12 @@ Per model, the type file holds `<Model>`, `<Model>Single`, `<Model>Multiple`, `<
80
83
  ## `weaver migrate`
81
84
 
82
85
  ```
83
- weaver migrate|mge [options]
86
+ weaver migrate|mge
84
87
  ```
85
88
 
89
+ Apply all pending database migrations (`prisma migrate deploy`). Takes no options, creates nothing, and never
90
+ prompts, which makes it the command to run in CI, in containers, and in production.
91
+
86
92
  ---
87
93
 
88
94
  ## `weaver migration`
@@ -102,10 +108,15 @@ Database migration commands.
102
108
 
103
109
  ### `weaver migration reset`
104
110
 
105
- | Option | Description | Default |
106
- |---------------|----------------------------------------------|---------|
107
- | `-f, --force` | Force reset for non-development environments | `false` |
108
- | `-y, --yes` | Skip confirmation prompt | `false` |
111
+ Drops the database, recreates it, and re-applies every migration (`prisma migrate reset`). **All data is lost.**
112
+
113
+ | Option | Description | Default |
114
+ |---------------|-----------------------------------------------------------|---------|
115
+ | `-f, --force` | Allow the reset outside the `dev` and `test` environments | `false` |
116
+ | `-y, --yes` | Skip confirmation prompt | `false` |
117
+
118
+ Without `--force` the command runs only when `NODE_ENV` resolves to `dev` or `test`, and aborts otherwise. Either
119
+ `--force` or `--yes` skips the Prisma confirmation prompt.
109
120
 
110
121
  ---
111
122
 
@@ -117,13 +128,13 @@ weaver seed|sd [options]
117
128
 
118
129
  Seed the database.
119
130
 
120
- | Option | Description | Default |
121
- |-------------------------|---------------------------------------------------------------------|-----------------------|
122
- | `--seedersPath [path]` | Seeders directory path | `config.SEEDERS_PATH` |
123
- | `-b, --buildProject` | Build the project before seeding | `false` |
124
- | `-p, --project` | TypeScript project build config file (used when `-b` is set) | `tsconfig.build.json` |
125
- | `-c, --continueOnError` | Continue seeder execution if error is thrown | `false` |
126
- | `-f, --fixWarnings` | Fix all seeder warnings like wrong checksum or deleted seeder files | `false` |
131
+ | Option | Description | Default |
132
+ |-------------------------|---------------------------------------------------------------------|------------------------------------|
133
+ | `--seedersPath [path]` | Seeders directory path | `config.DATABASE_SEEDERS_DIR_PATH` |
134
+ | `-b, --buildProject` | Build the project before seeding | `false` |
135
+ | `-p, --project` | TypeScript project build config file (used when `-b` is set) | `tsconfig.build.json` |
136
+ | `-c, --continueOnError` | Continue seeder execution if error is thrown | `false` |
137
+ | `-f, --fixWarnings` | Fix all seeder warnings like wrong checksum or deleted seeder files | `false` |
127
138
 
128
139
  ---
129
140
 
@@ -135,10 +146,10 @@ weaver start|s [options]
135
146
 
136
147
  Start the application.
137
148
 
138
- | Option | Description | Default |
139
- |-----------------|-------------------------------------------------------------|-----------------|
140
- | `-p, --project` | TypeScript project config file | `tsconfig.json` |
141
- | `-w, --watch` | Run in watch mode (recompiles and restarts on file changes) | `false` |
149
+ | Option | Description | Default |
150
+ |-----------------|-------------------------------------------------------------|-----------------------|
151
+ | `-p, --project` | TypeScript project config file | `tsconfig.build.json` |
152
+ | `-w, --watch` | Run in watch mode (recompiles and restarts on file changes) | `false` |
142
153
 
143
154
  ---
144
155
 
@@ -171,6 +182,9 @@ Requires `NODE_ENV=test`.
171
182
  | `--migrationName [name]` | Name for the initial migration | `init_test` |
172
183
  | `--verbose` | Print verbose output | `false` |
173
184
 
185
+ Aborts unless the storage, schema and client paths all resolve inside `--dir`, so a misconfigured test run cannot
186
+ touch the development database or uploads.
187
+
174
188
  ### `weaver test reset`
175
189
 
176
190
  Requires `NODE_ENV=test`. With no flags, resets both database and storage.