@flowcore/cli 2.22.0 → 3.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/CHANGELOG.md +20 -0
- package/README.md +63 -24
- package/oclif.manifest.json +1 -1
- package/package.json +7 -3
package/CHANGELOG.md
CHANGED
|
@@ -10,6 +10,26 @@
|
|
|
10
10
|
|
|
11
11
|
* added description to start that includes week ([58687a7](https://github.com/flowcore-io/flowcore-cli/commit/58687a7bbb66aaa5d6da26af88e555cbb1e72467))
|
|
12
12
|
|
|
13
|
+
## [3.0.1](https://github.com/flowcore-io/flowcore-cli/compare/v3.0.0...v3.0.1) (2024-08-29)
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Bug Fixes
|
|
17
|
+
|
|
18
|
+
* updated scenario to fix local stream ([7d58533](https://github.com/flowcore-io/flowcore-cli/commit/7d585330f92a41bf6314e7d9e17c332635d1e6ea))
|
|
19
|
+
|
|
20
|
+
## [3.0.0](https://github.com/flowcore-io/flowcore-cli/compare/v2.22.0...v3.0.0) (2024-08-29)
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
### ⚠ BREAKING CHANGES
|
|
24
|
+
|
|
25
|
+
* changed the signature of flowcore stream processing of everything other than log
|
|
26
|
+
* updated core package to support stream output processor extensions
|
|
27
|
+
|
|
28
|
+
### Features
|
|
29
|
+
|
|
30
|
+
* bumped flowcore scenario and core plugin ([a9d793f](https://github.com/flowcore-io/flowcore-cli/commit/a9d793fe451b181c918abc618835f65653aa17f8))
|
|
31
|
+
* updated core package to support stream output processor extensions ([a9a9a5e](https://github.com/flowcore-io/flowcore-cli/commit/a9a9a5ed45ab0dbe9af2055ce014d97d0f5aa659))
|
|
32
|
+
|
|
13
33
|
## [2.22.0](https://github.com/flowcore-io/flowcore-cli/compare/v2.21.0...v2.22.0) (2024-08-29)
|
|
14
34
|
|
|
15
35
|
|
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@ $ npm install -g @flowcore/cli
|
|
|
18
18
|
$ flowcore COMMAND
|
|
19
19
|
running command...
|
|
20
20
|
$ flowcore (--version)
|
|
21
|
-
@flowcore/cli/
|
|
21
|
+
@flowcore/cli/3.0.1 linux-x64 node-v20.17.0
|
|
22
22
|
$ flowcore --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ flowcore COMMAND
|
|
@@ -62,6 +62,7 @@ USAGE
|
|
|
62
62
|
* [`flowcore scenario generate transformer`](#flowcore-scenario-generate-transformer)
|
|
63
63
|
* [`flowcore scenario local`](#flowcore-scenario-local)
|
|
64
64
|
* [`flowcore stream STREAM`](#flowcore-stream-stream)
|
|
65
|
+
* [`flowcore stream http STREAM`](#flowcore-stream-http-stream)
|
|
65
66
|
* [`flowcore version`](#flowcore-version)
|
|
66
67
|
* [`flowcore whoami`](#flowcore-whoami)
|
|
67
68
|
|
|
@@ -85,7 +86,7 @@ EXAMPLES
|
|
|
85
86
|
$ flowcore apply -f ./path/to/manifest.yml
|
|
86
87
|
```
|
|
87
88
|
|
|
88
|
-
_See code: [src/commands/apply.ts](https://github.com/flowcore-io/flowcore-cli/blob/
|
|
89
|
+
_See code: [src/commands/apply.ts](https://github.com/flowcore-io/flowcore-cli/blob/v3.0.1/src/commands/apply.ts)_
|
|
89
90
|
|
|
90
91
|
## `flowcore autocomplete [SHELL]`
|
|
91
92
|
|
|
@@ -331,7 +332,7 @@ EXAMPLES
|
|
|
331
332
|
$ flowcore get adapter adapter-name -t tenant-name -s scenario-name
|
|
332
333
|
```
|
|
333
334
|
|
|
334
|
-
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/
|
|
335
|
+
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.1/src/commands/get/adapter.ts)_
|
|
335
336
|
|
|
336
337
|
## `flowcore get scenario [SCENARIO]`
|
|
337
338
|
|
|
@@ -357,7 +358,7 @@ EXAMPLES
|
|
|
357
358
|
$ flowcore get scenario scenario-name -t tenant-name
|
|
358
359
|
```
|
|
359
360
|
|
|
360
|
-
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/
|
|
361
|
+
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.1/src/commands/get/scenario.ts)_
|
|
361
362
|
|
|
362
363
|
## `flowcore help [COMMANDS]`
|
|
363
364
|
|
|
@@ -435,7 +436,7 @@ EXAMPLES
|
|
|
435
436
|
$ flowcore logs adapter adapter-name -t tenant-name -s scenario-name --json
|
|
436
437
|
```
|
|
437
438
|
|
|
438
|
-
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/
|
|
439
|
+
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.1/src/commands/logs/adapter.ts)_
|
|
439
440
|
|
|
440
441
|
## `flowcore new bun-service NAME`
|
|
441
442
|
|
|
@@ -854,7 +855,7 @@ EXAMPLES
|
|
|
854
855
|
$ flowcore reset adapter adapter-name -t tenant-name -s scenario-name -e 9cb35da2-ba64-4bb5-86d6-ef20ebc62ab7
|
|
855
856
|
```
|
|
856
857
|
|
|
857
|
-
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/
|
|
858
|
+
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.1/src/commands/reset/adapter.ts)_
|
|
858
859
|
|
|
859
860
|
## `flowcore scenario apply`
|
|
860
861
|
|
|
@@ -884,7 +885,7 @@ EXAMPLES
|
|
|
884
885
|
$ cat <<EOF | flowcore scenario apply -f -
|
|
885
886
|
```
|
|
886
887
|
|
|
887
|
-
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/
|
|
888
|
+
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.1/src/commands/scenario/apply.ts)_
|
|
888
889
|
|
|
889
890
|
## `flowcore scenario generate manifest`
|
|
890
891
|
|
|
@@ -916,7 +917,7 @@ EXAMPLES
|
|
|
916
917
|
$ flowcore scenario generate manifest -t flowcore -n scenario-name -f example.yaml
|
|
917
918
|
```
|
|
918
919
|
|
|
919
|
-
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/
|
|
920
|
+
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.1/src/commands/scenario/generate/manifest.ts)_
|
|
920
921
|
|
|
921
922
|
## `flowcore scenario generate transformer`
|
|
922
923
|
|
|
@@ -943,7 +944,7 @@ EXAMPLES
|
|
|
943
944
|
$ flowcore scenario generate transformer -n flow-type-name -d "description of the transformer" -f example.yaml
|
|
944
945
|
```
|
|
945
946
|
|
|
946
|
-
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/
|
|
947
|
+
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.1/src/commands/scenario/generate/transformer.ts)_
|
|
947
948
|
|
|
948
949
|
## `flowcore scenario local`
|
|
949
950
|
|
|
@@ -975,16 +976,58 @@ EXAMPLES
|
|
|
975
976
|
$ cat <<EOF | flowcore scenario local -f -
|
|
976
977
|
```
|
|
977
978
|
|
|
978
|
-
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/
|
|
979
|
+
_See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.1/src/commands/scenario/local.ts)_
|
|
979
980
|
|
|
980
981
|
## `flowcore stream STREAM`
|
|
981
982
|
|
|
982
|
-
Stream events from a datacore running on the Flowcore Platform
|
|
983
|
+
Stream events from a datacore running on the Flowcore Platform and output them to the console
|
|
983
984
|
|
|
984
985
|
```
|
|
985
986
|
USAGE
|
|
986
|
-
$ flowcore stream STREAM [--profile <value>] [-e <value>] [-j] [-l] [-m <value>] [-
|
|
987
|
-
[-
|
|
987
|
+
$ flowcore stream STREAM [--profile <value>] [-e <value>] [-j] [-l] [-m <value>] [-p] [-c] [-s <value>]
|
|
988
|
+
[-o <value>]
|
|
989
|
+
|
|
990
|
+
ARGUMENTS
|
|
991
|
+
STREAM stream url to connect to
|
|
992
|
+
|
|
993
|
+
FLAGS
|
|
994
|
+
-c, --scan Scan the full time range
|
|
995
|
+
-e, --end=<value> End time to stream to, example: 2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now
|
|
996
|
+
-j, --json Output json only
|
|
997
|
+
-l, --[no-]live Change to live mode when reaching last time bucket
|
|
998
|
+
-m, --max=<value> Maximum number of events to send to the destination
|
|
999
|
+
-o, --output=<value> [default: log] Output to send events to (deprecated, use subcommand instead to specify output)
|
|
1000
|
+
-p, --payload Only send the event payload to the destination
|
|
1001
|
+
-s, --start=<value> Start time bucket to stream from, example: (2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now)
|
|
1002
|
+
--profile=<value> Specify the configuration profile to use
|
|
1003
|
+
|
|
1004
|
+
DESCRIPTION
|
|
1005
|
+
Stream events from a datacore running on the Flowcore Platform and output them to the console
|
|
1006
|
+
|
|
1007
|
+
EXAMPLES
|
|
1008
|
+
$ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream"
|
|
1009
|
+
|
|
1010
|
+
$ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s 1y
|
|
1011
|
+
|
|
1012
|
+
$ flowcore stream "https://flowcore.io/<org>/<data core>/*" -s 1y
|
|
1013
|
+
|
|
1014
|
+
$ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/*" -s 1y
|
|
1015
|
+
|
|
1016
|
+
$ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s 3m --json > some.json
|
|
1017
|
+
|
|
1018
|
+
$ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/[<event type1>,<event type2>,<event type3>].stream" -s 3m
|
|
1019
|
+
```
|
|
1020
|
+
|
|
1021
|
+
_See code: [@flowcore/cli-plugin-core](https://github.com/flowcore/flowcore-cli-plugin-core/blob/v2.0.0/src/commands/stream.ts)_
|
|
1022
|
+
|
|
1023
|
+
## `flowcore stream http STREAM`
|
|
1024
|
+
|
|
1025
|
+
Stream events from a datacore running on the Flowcore Platform and stream to a http endpoint
|
|
1026
|
+
|
|
1027
|
+
```
|
|
1028
|
+
USAGE
|
|
1029
|
+
$ flowcore stream http STREAM [--profile <value>] [-e <value>] [-j] [-l] [-m <value>] [-p] [-c] [-s <value>]
|
|
1030
|
+
[-d <value>] [-H <value>] [-t <value>]
|
|
988
1031
|
|
|
989
1032
|
ARGUMENTS
|
|
990
1033
|
STREAM stream url to connect to
|
|
@@ -997,31 +1040,27 @@ FLAGS
|
|
|
997
1040
|
-j, --json Output json only
|
|
998
1041
|
-l, --[no-]live Change to live mode when reaching last time bucket
|
|
999
1042
|
-m, --max=<value> Maximum number of events to send to the destination
|
|
1000
|
-
-o, --output=<option> [default: http] Output format
|
|
1001
|
-
<options: http|log>
|
|
1002
1043
|
-p, --payload Only send the event payload to the destination
|
|
1003
1044
|
-s, --start=<value> Start time bucket to stream from, example: (2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now)
|
|
1004
1045
|
-t, --timeout=<value> [default: 5000] Timeout in milliseconds to wait for a response from the destination
|
|
1005
1046
|
--profile=<value> Specify the configuration profile to use
|
|
1006
1047
|
|
|
1007
1048
|
DESCRIPTION
|
|
1008
|
-
Stream events from a datacore running on the Flowcore Platform
|
|
1049
|
+
Stream events from a datacore running on the Flowcore Platform and stream to a http endpoint
|
|
1009
1050
|
|
|
1010
1051
|
EXAMPLES
|
|
1011
|
-
$ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream"
|
|
1052
|
+
$ flowcore stream http "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -d http://localhost:3000/transform
|
|
1012
1053
|
|
|
1013
|
-
$ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s 1y
|
|
1054
|
+
$ flowcore stream http "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s 1y -d http://localhost:3000/transform
|
|
1014
1055
|
|
|
1015
|
-
$ flowcore stream "https://flowcore.io/<org>/<data core>/*" -s 1y
|
|
1016
|
-
|
|
1017
|
-
$ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/*" -s 1y
|
|
1056
|
+
$ flowcore stream http "https://flowcore.io/<org>/<data core>/*" -s 1y -d http://localhost:3000/transform
|
|
1018
1057
|
|
|
1019
|
-
$ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type
|
|
1058
|
+
$ flowcore stream http "https://flowcore.io/<org>/<data core>/<flow type>/*" -s 1y -d http://localhost:3000/transform
|
|
1020
1059
|
|
|
1021
|
-
$ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/[<event type1>,<event type2>,<event type3>].stream" -
|
|
1060
|
+
$ flowcore stream http "https://flowcore.io/<org>/<data core>/<flow type>/[<event type1>,<event type2>,<event type3>].stream" -s 3m -d http://localhost:3000/transform
|
|
1022
1061
|
```
|
|
1023
1062
|
|
|
1024
|
-
_See code: [@flowcore/cli-plugin-core](https://github.com/flowcore/flowcore-cli-plugin-core/blob/
|
|
1063
|
+
_See code: [@flowcore/cli-plugin-core](https://github.com/flowcore/flowcore-cli-plugin-core/blob/v2.0.0/src/commands/stream/http.ts)_
|
|
1025
1064
|
|
|
1026
1065
|
## `flowcore version`
|
|
1027
1066
|
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -6,10 +6,10 @@
|
|
|
6
6
|
"dependencies": {
|
|
7
7
|
"@datastructures-js/queue": "^4.2.3",
|
|
8
8
|
"@flowcore/cli-plugin-config": "^1.1.0",
|
|
9
|
-
"@flowcore/cli-plugin-core": "^
|
|
9
|
+
"@flowcore/cli-plugin-core": "^2.0.0",
|
|
10
10
|
"@flowcore/cli-plugin-data-core": "^2.2.2",
|
|
11
11
|
"@flowcore/cli-plugin-generator": "^1.3.0",
|
|
12
|
-
"@flowcore/cli-plugin-scenario": "^
|
|
12
|
+
"@flowcore/cli-plugin-scenario": "^3.0.1",
|
|
13
13
|
"@flowcore/time-bucket": "^1.1.0",
|
|
14
14
|
"@oclif/core": "^3",
|
|
15
15
|
"@oclif/plugin-autocomplete": "^3.0.2",
|
|
@@ -69,6 +69,7 @@
|
|
|
69
69
|
"commands": "./dist/commands",
|
|
70
70
|
"plugins": [
|
|
71
71
|
"@oclif/plugin-help",
|
|
72
|
+
"@oclif/plugin-warn-if-update-available",
|
|
72
73
|
"@oclif/plugin-version",
|
|
73
74
|
"@oclif/plugin-plugins",
|
|
74
75
|
"@oclif/plugin-autocomplete",
|
|
@@ -80,6 +81,9 @@
|
|
|
80
81
|
"@flowcore/cli-plugin-core",
|
|
81
82
|
"@flowcore/cli-plugin-generator"
|
|
82
83
|
],
|
|
84
|
+
"warnIfUpdateAvailable": {
|
|
85
|
+
"timeoutInDays": 2
|
|
86
|
+
},
|
|
83
87
|
"topicSeparator": " "
|
|
84
88
|
},
|
|
85
89
|
"repository": "flowcore-io/flowcore-cli",
|
|
@@ -96,7 +100,7 @@
|
|
|
96
100
|
"prestart": "npm run build",
|
|
97
101
|
"update-schema": "rover graph introspect https://graph.api.staging.flowcore.io/graphql -o schema.gql"
|
|
98
102
|
},
|
|
99
|
-
"version": "
|
|
103
|
+
"version": "3.0.1",
|
|
100
104
|
"bugs": "https://github.com/flowcore-io/flowcore-cli/issues",
|
|
101
105
|
"keywords": [
|
|
102
106
|
"flowcore",
|