You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This command scaffolds a brand new AdminForth application in a specified directory. It guides you through setup using command-line arguments or interactive prompts, generates the necessary configuration and project files, installs dependencies, and sets up the development environment.
27
+
The `create-app`command scaffolds a brand new AdminForth application in a specified directory. The `create-app` command guides you through setup using command-line arguments or interactive prompts, generates the necessary configuration and project files, installs dependencies, and sets up the development environment.
28
28
29
29
**Usage:**
30
30
@@ -77,7 +77,7 @@ Creates a folder `my-app/` with the entire AdminForth app ready to go.
77
77
78
78
**Description:**
79
79
80
-
This command sets up a fresh AdminForth plugin project by generating the required files, installing dependencies, and preparing the environment for local development and testing.
80
+
The `create-plugin` command sets up a fresh AdminForth plugin project by generating the required files, installing dependencies, and preparing the environment for local development and testing.
81
81
82
82
**Usage:**
83
83
@@ -124,7 +124,7 @@ Creates a folder with all the necessary files for your plugin and instructions f
124
124
125
125
**Description:**
126
126
127
-
This command scans the current working directory for a valid AdminForth instance and automatically generates a TypeScript file containing model type definitions for all defined resources. It inspects the resource columns and maps them to appropriate TypeScript types.
127
+
The `generate-models`command scans the current working directory for a valid AdminForth instance and automatically generates a TypeScript file containing model type definitions for all defined resources. The `generate-models` command inspects the resource columns and maps them to appropriate TypeScript types.
128
128
129
129
**Usage:**
130
130
@@ -191,7 +191,7 @@ export type Product = {
191
191
192
192
**Description:**
193
193
194
-
This command bundles the AdminForth front-end (SPA) using your current AdminForth instance. It calls the `bundleNow()` method from your AdminForth admin entry point.
194
+
The `bundle`command bundles the AdminForth front-end (SPA) using your current AdminForth instance. The `bundle` command calls the `bundleNow()` method from your AdminForth admin entry point.
195
195
196
196
**Usage:**
197
197
@@ -201,7 +201,7 @@ pnpx adminforth bundle
201
201
202
202
**Output:**
203
203
204
-
The output files (typically JavaScript/CSS assets) will be generated in the directory configured by your AdminForth project (usually `dist` or `public`).
204
+
The `bundle` command generates output files (typically JavaScript/CSS assets) in the directory configured by your AdminForth project (usually `dist` or `public`).
205
205
206
206
207
207
@@ -225,9 +225,9 @@ The output files (typically JavaScript/CSS assets) will be generated in the dire
225
225
226
226
### `component`
227
227
228
-
The `component` command is an interactive CLI tool to scaffold and inject Vue components into your AdminForth plugin.
228
+
The `component` command is an interactive CLI tool that scaffolds and injects Vue components into your AdminForth plugin.
229
229
230
-
It helps you generate:
230
+
The `component` command helps you generate:
231
231
- Custom field components (`fields`)
232
232
- CRUD page injections (`crudPage`)
233
233
- Login page injections (`login`)
@@ -237,18 +237,18 @@ It helps you generate:
237
237
238
238
#### 🔤 Custom Fields (`fields`)
239
239
240
-
Generates components for specific fields in views such as:
240
+
The `component fields` flow generates components for specific fields in views such as:
241
241
-`list`
242
242
-`show`
243
243
-`edit`
244
244
-`create`
245
245
-`filter`
246
246
247
-
It prompts to select a **resource**, then a **column**, and finally injects a file like:
247
+
The `component fields` flow prompts you to select a **resource**, then a **column**, and finally injects a file like:
248
248
```bash
249
249
custom/UserEmailShow.vue
250
250
```
251
-
Config will be auto-updated.
251
+
The `component fields` flow auto-updates the config.
- Config file `index.ts` must exist and export `admin`
320
320
321
-
If the component file already exists, you’ll get a warning and it won’t be overwritten.
321
+
If the generated component file already exists, the `component` command shows a warning and does not overwrite the existing file.
322
322
323
323
---
324
324
@@ -344,7 +344,7 @@ If the component file already exists, you’ll get a warning and it won’t be o
344
344
345
345
**Description:**
346
346
347
-
This command helps you scaffold a new resource file for a selected table in your database and automatically integrates it into the AdminForth application. It fetches available tables, lets you select one interactively, generates a corresponding resource file using a template, and injects the result into your application’s index file.
347
+
The `resource`command helps you scaffold a new resource file for a selected table in your database and automatically integrates it into the AdminForth application. The `resource` command fetches available tables, lets you select one interactively, generates a corresponding resource file using a template, and injects the result into your application’s index file.
348
348
349
349
**Usage:**
350
350
@@ -394,7 +394,7 @@ pnpx adminforth resource
394
394
395
395
**Description:**
396
396
397
-
This command outputs a summary of all supported AdminForth commands in the terminal with brief descriptions. It’s useful as a quick reference for developers to understand what functionality is available.
397
+
The `help`command outputs a summary of all supported AdminForth commands in the terminal with brief descriptions. The `help` command is useful as a quick reference for developers to understand what functionality is available.
398
398
399
399
**Usage:**
400
400
@@ -414,7 +414,7 @@ Available commands:
414
414
resource Scaffold a custom resource
415
415
```
416
416
417
-
This command is typically displayed by running `adminforth` with no arguments or explicitly using`adminforth help`.
417
+
The `help` output is typically displayed by running `adminforth` with no arguments or explicitly running`adminforth help`.
418
418
419
419
---
420
420
@@ -443,7 +443,7 @@ This command is typically displayed by running `adminforth` with no arguments or
443
443
444
444
**Description:**
445
445
446
-
This command displays the version number of the currently installed AdminForth CLI. It's useful for verifying which version you're using, especially when troubleshooting or checking compatibility.
446
+
The `version`command displays the version number of the currently installed AdminForth CLI. The `version` command is useful for verifying which version you are using, especially when troubleshooting or checking compatibility.
0 commit comments