@trayio/cdk-cli 0.0.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 +123 -0
- package/bin/dev +17 -0
- package/bin/dev.cmd +3 -0
- package/bin/run +5 -0
- package/bin/run.cmd +3 -0
- package/oclif.manifest.json +16 -0
- package/package.json +66 -0
package/README.md
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# @trayio/connector-cli
|
|
2
|
+
|
|
3
|
+
A collection of CLI commands for connector development.
|
|
4
|
+
|
|
5
|
+
# Contributing
|
|
6
|
+
|
|
7
|
+
[Guide on contributing](./CONTRIBUTING.md)
|
|
8
|
+
|
|
9
|
+
# Table of Contents
|
|
10
|
+
|
|
11
|
+
<!-- toc -->
|
|
12
|
+
* [@trayio/connector-cli](#trayioconnector-cli)
|
|
13
|
+
* [Contributing](#contributing)
|
|
14
|
+
* [Table of Contents](#table-of-contents)
|
|
15
|
+
* [Usage](#usage)
|
|
16
|
+
* [Commands](#commands)
|
|
17
|
+
<!-- tocstop -->
|
|
18
|
+
|
|
19
|
+
# Usage
|
|
20
|
+
|
|
21
|
+
<!-- usage -->
|
|
22
|
+
```sh-session
|
|
23
|
+
$ npm install -g @trayio/cdk-cli
|
|
24
|
+
$ cdk COMMAND
|
|
25
|
+
running command...
|
|
26
|
+
$ cdk (--version|-v)
|
|
27
|
+
@trayio/cdk-cli/0.0.1 darwin-x64 node-v14.21.3
|
|
28
|
+
$ cdk --help [COMMAND]
|
|
29
|
+
USAGE
|
|
30
|
+
$ cdk COMMAND
|
|
31
|
+
...
|
|
32
|
+
```
|
|
33
|
+
<!-- usagestop -->
|
|
34
|
+
|
|
35
|
+
# Commands
|
|
36
|
+
|
|
37
|
+
<!-- commands -->
|
|
38
|
+
* [`cdk autocomplete [SHELL]`](#cdk-autocomplete-shell)
|
|
39
|
+
* [`cdk hello`](#cdk-hello)
|
|
40
|
+
* [`cdk help [COMMANDS]`](#cdk-help-commands)
|
|
41
|
+
* [`cdk version`](#cdk-version)
|
|
42
|
+
|
|
43
|
+
## `cdk autocomplete [SHELL]`
|
|
44
|
+
|
|
45
|
+
display autocomplete installation instructions
|
|
46
|
+
|
|
47
|
+
```
|
|
48
|
+
USAGE
|
|
49
|
+
$ cdk autocomplete [SHELL] [-r]
|
|
50
|
+
|
|
51
|
+
ARGUMENTS
|
|
52
|
+
SHELL shell type
|
|
53
|
+
|
|
54
|
+
FLAGS
|
|
55
|
+
-r, --refresh-cache Refresh cache (ignores displaying instructions)
|
|
56
|
+
|
|
57
|
+
DESCRIPTION
|
|
58
|
+
display autocomplete installation instructions
|
|
59
|
+
|
|
60
|
+
EXAMPLES
|
|
61
|
+
$ cdk autocomplete
|
|
62
|
+
|
|
63
|
+
$ cdk autocomplete bash
|
|
64
|
+
|
|
65
|
+
$ cdk autocomplete zsh
|
|
66
|
+
|
|
67
|
+
$ cdk autocomplete --refresh-cache
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
_See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v2.1.9/src/commands/autocomplete/index.ts)_
|
|
71
|
+
|
|
72
|
+
## `cdk hello`
|
|
73
|
+
|
|
74
|
+
Hello world
|
|
75
|
+
|
|
76
|
+
```
|
|
77
|
+
USAGE
|
|
78
|
+
$ cdk hello
|
|
79
|
+
|
|
80
|
+
DESCRIPTION
|
|
81
|
+
Hello world
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## `cdk help [COMMANDS]`
|
|
85
|
+
|
|
86
|
+
Display help for cdk.
|
|
87
|
+
|
|
88
|
+
```
|
|
89
|
+
USAGE
|
|
90
|
+
$ cdk help [COMMANDS] [-n]
|
|
91
|
+
|
|
92
|
+
ARGUMENTS
|
|
93
|
+
COMMANDS Command to show help for.
|
|
94
|
+
|
|
95
|
+
FLAGS
|
|
96
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
97
|
+
|
|
98
|
+
DESCRIPTION
|
|
99
|
+
Display help for cdk.
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
|
|
103
|
+
|
|
104
|
+
## `cdk version`
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
USAGE
|
|
108
|
+
$ cdk version [--json] [--verbose]
|
|
109
|
+
|
|
110
|
+
FLAGS
|
|
111
|
+
--verbose Show additional information about the CLI.
|
|
112
|
+
|
|
113
|
+
GLOBAL FLAGS
|
|
114
|
+
--json Format output as json.
|
|
115
|
+
|
|
116
|
+
FLAG DESCRIPTIONS
|
|
117
|
+
--verbose Show additional information about the CLI.
|
|
118
|
+
|
|
119
|
+
Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
_See code: [@oclif/plugin-version](https://github.com/oclif/plugin-version/blob/v1.3.3/src/commands/version.ts)_
|
|
123
|
+
<!-- commandsstop -->
|
package/bin/dev
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
const oclif = require('@oclif/core')
|
|
4
|
+
|
|
5
|
+
const path = require('path')
|
|
6
|
+
const project = path.join(__dirname, '..', 'tsconfig.json')
|
|
7
|
+
|
|
8
|
+
// In dev mode -> use ts-node and dev plugins
|
|
9
|
+
process.env.NODE_ENV = 'development'
|
|
10
|
+
|
|
11
|
+
require('ts-node').register({project})
|
|
12
|
+
|
|
13
|
+
// In dev mode, always show stack traces
|
|
14
|
+
oclif.settings.debug = true;
|
|
15
|
+
|
|
16
|
+
// Start the CLI
|
|
17
|
+
oclif.run().then(oclif.flush).catch(oclif.Errors.handle)
|
package/bin/dev.cmd
ADDED
package/bin/run
ADDED
package/bin/run.cmd
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": "0.0.1",
|
|
3
|
+
"commands": {
|
|
4
|
+
"hello": {
|
|
5
|
+
"id": "hello",
|
|
6
|
+
"description": "Hello world",
|
|
7
|
+
"strict": true,
|
|
8
|
+
"pluginName": "@trayio/cdk-cli",
|
|
9
|
+
"pluginAlias": "@trayio/cdk-cli",
|
|
10
|
+
"pluginType": "core",
|
|
11
|
+
"aliases": [],
|
|
12
|
+
"flags": {},
|
|
13
|
+
"args": {}
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@trayio/cdk-cli",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "A collection of CLI commands for connector development.",
|
|
5
|
+
"main": "index.js",
|
|
6
|
+
"types": "index.d.ts",
|
|
7
|
+
"exports": {
|
|
8
|
+
"require": "./dist/index.js",
|
|
9
|
+
"import": "./dist/index.js",
|
|
10
|
+
"types": "./dist/index.d.ts"
|
|
11
|
+
},
|
|
12
|
+
"license": "MIT",
|
|
13
|
+
"dependencies": {
|
|
14
|
+
"@oclif/core": "*",
|
|
15
|
+
"@oclif/plugin-autocomplete": "*",
|
|
16
|
+
"@oclif/plugin-help": "*",
|
|
17
|
+
"@oclif/plugin-version": "*",
|
|
18
|
+
"@oclif/test": "*"
|
|
19
|
+
},
|
|
20
|
+
"typesVersions": {
|
|
21
|
+
"*": {
|
|
22
|
+
"*": [
|
|
23
|
+
"*",
|
|
24
|
+
"dist/*"
|
|
25
|
+
]
|
|
26
|
+
}
|
|
27
|
+
},
|
|
28
|
+
"files": [
|
|
29
|
+
"/bin",
|
|
30
|
+
"/dist",
|
|
31
|
+
"/npm-shrinkwrap.json",
|
|
32
|
+
"/oclif.manifest.json"
|
|
33
|
+
],
|
|
34
|
+
"bin": "./bin/run",
|
|
35
|
+
"oclif": {
|
|
36
|
+
"commands": "./dist/commands",
|
|
37
|
+
"bin": "cdk",
|
|
38
|
+
"topics": {
|
|
39
|
+
"connector": {
|
|
40
|
+
"description": "Connector related commands"
|
|
41
|
+
},
|
|
42
|
+
"multi": {
|
|
43
|
+
"description": "Connector related commands targeting multiple environments/regions. (Default: US, EU1 and AP1. Staging flag: Staging and Frontend-staging)"
|
|
44
|
+
},
|
|
45
|
+
"generate": {
|
|
46
|
+
"description": "Run generators for things like connectors, operations, tests, etc."
|
|
47
|
+
}
|
|
48
|
+
},
|
|
49
|
+
"plugins": [
|
|
50
|
+
"@oclif/plugin-help",
|
|
51
|
+
"@oclif/plugin-autocomplete",
|
|
52
|
+
"@oclif/plugin-version"
|
|
53
|
+
],
|
|
54
|
+
"additionalHelpFlags": [
|
|
55
|
+
"-h"
|
|
56
|
+
],
|
|
57
|
+
"additionalVersionFlags": [
|
|
58
|
+
"-v"
|
|
59
|
+
]
|
|
60
|
+
},
|
|
61
|
+
"scripts": {
|
|
62
|
+
"oclif:clean": "rm -f oclif.manifest.json",
|
|
63
|
+
"postcompile": "oclif manifest && oclif readme"
|
|
64
|
+
},
|
|
65
|
+
"gitHead": "f5c9d4eaec4f9d523356b4ed96698644acfce32d"
|
|
66
|
+
}
|