@travetto/cli 3.0.2 → 3.0.3
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 +3 -3
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
<!-- This file was generated by @travetto/doc and should not be modified directly -->
|
|
2
|
-
<!-- Please modify https://github.com/travetto/travetto/tree/main/module/cli/DOC.
|
|
2
|
+
<!-- Please modify https://github.com/travetto/travetto/tree/main/module/cli/DOC.tsx and execute "npx trv doc" to rebuild -->
|
|
3
3
|
# Command Line Interface
|
|
4
|
+
|
|
4
5
|
## CLI infrastructure for Travetto framework
|
|
5
6
|
|
|
6
7
|
**Install: @travetto/cli**
|
|
@@ -12,7 +13,7 @@ npm install @travetto/cli
|
|
|
12
13
|
yarn add @travetto/cli
|
|
13
14
|
```
|
|
14
15
|
|
|
15
|
-
The cli is the primary structure for interacting with the external requirements of the framework. This can range from running tests, to running applications, to generating email templates. The main executable can be installed globally or locally. If installed globally and locally, it will defer to the local installation for execution.
|
|
16
|
+
The cli is the primary structure for interacting with the external requirements of the framework. This can range from running tests, to running applications, to generating email templates. The main executable can be installed globally or locally. If installed globally and locally, it will defer to the local installation for execution.
|
|
16
17
|
|
|
17
18
|
As is the custom, modules are able to register their own cli extensions as scripts, whose name starts with `cli.`. These scripts are then picked up at runtime and all available options are provided when viewing the help documentation. The following are all the supported cli operations and the various settings they allow.
|
|
18
19
|
|
|
@@ -37,7 +38,6 @@ Commands:
|
|
|
37
38
|
This will show all the available options/choices that are exposed given the currently installed modules.
|
|
38
39
|
|
|
39
40
|
## Extending
|
|
40
|
-
|
|
41
41
|
Extending the `cli` is fairly straightforward. It is built upon [commander](https://www.npmjs.com/package/commander), with a model that is extensible:
|
|
42
42
|
|
|
43
43
|
**Code: Echo Command**
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@travetto/cli",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.3",
|
|
4
4
|
"description": "CLI infrastructure for Travetto framework",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"cli",
|
|
@@ -24,9 +24,9 @@
|
|
|
24
24
|
"directory": "module/cli"
|
|
25
25
|
},
|
|
26
26
|
"dependencies": {
|
|
27
|
-
"@travetto/base": "^3.0.
|
|
28
|
-
"@travetto/terminal": "^3.0.
|
|
29
|
-
"@travetto/worker": "^3.0.
|
|
27
|
+
"@travetto/base": "^3.0.3",
|
|
28
|
+
"@travetto/terminal": "^3.0.3",
|
|
29
|
+
"@travetto/worker": "^3.0.3",
|
|
30
30
|
"commander": "^10.0.0"
|
|
31
31
|
},
|
|
32
32
|
"travetto": {
|