@appshell/cli 0.3.0-alpha.3 → 0.3.0-alpha.5

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 (3) hide show
  1. package/README.md +18 -11
  2. package/dist/main.js +1 -1
  3. package/package.json +2 -2
package/README.md CHANGED
@@ -37,19 +37,27 @@ pnpm add -D @appshell/cli
37
37
 
38
38
  ## Usage
39
39
 
40
+ ```bash
41
+ appshell [command]
42
+
43
+ Commands:
44
+ appshell generate [target] Generates a resource
45
+ appshell register Register one or more appshell manifests
46
+ appshell start Start the appshell runtime environment
47
+ ```
48
+
49
+ ### appshell generate
50
+
40
51
  ```bash
41
52
  appshell generate [target]
42
53
 
43
54
  Generates a resource
44
55
 
45
56
  Commands:
46
- appshell generate manifest Generate the appshell manifest
47
- appshell generate env Generate the runtime environment js file that refl
48
- ects the current process.env
49
-
50
- Options:
51
- --help Show help [boolean]
52
- --version Show version number [boolean]
57
+ appshell generate manifest Generate the appshell manifest by processing the template specified by --template
58
+ appshell generate env Generate the runtime environment js file that reflects the current process.env
59
+ appshell generate index Generate the appshell index file by merging sources specifed by --registry options
60
+ appshell generate metadata Generate the appshell metadata file by merging sources specifed by --registry options
53
61
  ```
54
62
 
55
63
  ## Generate manifest
@@ -64,16 +72,15 @@ Generate the appshell global runtime manifest
64
72
  Options:
65
73
  --help Show help [boolean]
66
74
  --version Show version number [boolean]
67
- -c, --configsDir Path to the appshell configs dir to process [string] [default: "appshell_configs"]
68
- -d, --depth Depth to search for app manifests in configsDir [number] [default: 1]
69
- -o, --outDir Output location for the appshell manifest [string] [default: "."]
75
+ -t, --template Path to the appshell manifest template to process [string] [default: "appshell.config.json"]
76
+ -o, --outDir Output location for the appshell manifest [string] [default: "dist"]
70
77
  -f, --outFile Output filename for the appshell manifest [string] [default: "appshell.manifest.json"]
71
78
  ```
72
79
 
73
80
  ### Sample usage
74
81
 
75
82
  ```bash
76
- appshell generate manifest --configsDir $CONFIGS_DIR
83
+ appshell generate manifest --template dist/appshell.config.json
77
84
  ```
78
85
 
79
86
  **Where does the content of CONFIGS_DIR come from?**