@flowcore/cli 2.21.0 → 3.0.0

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 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.0](https://github.com/flowcore-io/flowcore-cli/compare/v2.22.0...v3.0.0) (2024-08-29)
14
+
15
+
16
+ ### ⚠ BREAKING CHANGES
17
+
18
+ * changed the signature of flowcore stream processing of everything other than log
19
+ * updated core package to support stream output processor extensions
20
+
21
+ ### Features
22
+
23
+ * bumped flowcore scenario and core plugin ([a9d793f](https://github.com/flowcore-io/flowcore-cli/commit/a9d793fe451b181c918abc618835f65653aa17f8))
24
+ * updated core package to support stream output processor extensions ([a9a9a5e](https://github.com/flowcore-io/flowcore-cli/commit/a9a9a5ed45ab0dbe9af2055ce014d97d0f5aa659))
25
+
26
+ ## [2.22.0](https://github.com/flowcore-io/flowcore-cli/compare/v2.21.0...v2.22.0) (2024-08-29)
27
+
28
+
29
+ ### Features
30
+
31
+ * added create new plugin feature ([fbeadda](https://github.com/flowcore-io/flowcore-cli/commit/fbeaddaa4e3cf956a425aca7a4d6948c397df217))
32
+
13
33
  ## [2.21.0](https://github.com/flowcore-io/flowcore-cli/compare/v2.20.0...v2.21.0) (2024-08-28)
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/2.21.0 linux-x64 node-v20.17.0
21
+ @flowcore/cli/3.0.0 linux-x64 node-v20.17.0
22
22
  $ flowcore --help [COMMAND]
23
23
  USAGE
24
24
  $ flowcore COMMAND
@@ -44,6 +44,7 @@ USAGE
44
44
  * [`flowcore new bun-service NAME`](#flowcore-new-bun-service-name)
45
45
  * [`flowcore new generator NAME`](#flowcore-new-generator-name)
46
46
  * [`flowcore new nextjs-app NAME`](#flowcore-new-nextjs-app-name)
47
+ * [`flowcore new plugin NAME`](#flowcore-new-plugin-name)
47
48
  * [`flowcore plugins`](#flowcore-plugins)
48
49
  * [`flowcore plugins:install PLUGIN...`](#flowcore-pluginsinstall-plugin)
49
50
  * [`flowcore plugins:inspect PLUGIN...`](#flowcore-pluginsinspect-plugin)
@@ -61,6 +62,7 @@ USAGE
61
62
  * [`flowcore scenario generate transformer`](#flowcore-scenario-generate-transformer)
62
63
  * [`flowcore scenario local`](#flowcore-scenario-local)
63
64
  * [`flowcore stream STREAM`](#flowcore-stream-stream)
65
+ * [`flowcore stream http STREAM`](#flowcore-stream-http-stream)
64
66
  * [`flowcore version`](#flowcore-version)
65
67
  * [`flowcore whoami`](#flowcore-whoami)
66
68
 
@@ -84,7 +86,7 @@ EXAMPLES
84
86
  $ flowcore apply -f ./path/to/manifest.yml
85
87
  ```
86
88
 
87
- _See code: [src/commands/apply.ts](https://github.com/flowcore-io/flowcore-cli/blob/v2.21.0/src/commands/apply.ts)_
89
+ _See code: [src/commands/apply.ts](https://github.com/flowcore-io/flowcore-cli/blob/v3.0.0/src/commands/apply.ts)_
88
90
 
89
91
  ## `flowcore autocomplete [SHELL]`
90
92
 
@@ -303,7 +305,7 @@ EXAMPLES
303
305
  $ flowcore generate nextjs-entity my-entity
304
306
  ```
305
307
 
306
- _See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.2.0/src/commands/generate/nextjs-entity.ts)_
308
+ _See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.3.0/src/commands/generate/nextjs-entity.ts)_
307
309
 
308
310
  ## `flowcore get adapter [ADAPTER]`
309
311
 
@@ -330,7 +332,7 @@ EXAMPLES
330
332
  $ flowcore get adapter adapter-name -t tenant-name -s scenario-name
331
333
  ```
332
334
 
333
- _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v2.13.1/src/commands/get/adapter.ts)_
335
+ _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.0/src/commands/get/adapter.ts)_
334
336
 
335
337
  ## `flowcore get scenario [SCENARIO]`
336
338
 
@@ -356,7 +358,7 @@ EXAMPLES
356
358
  $ flowcore get scenario scenario-name -t tenant-name
357
359
  ```
358
360
 
359
- _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v2.13.1/src/commands/get/scenario.ts)_
361
+ _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.0/src/commands/get/scenario.ts)_
360
362
 
361
363
  ## `flowcore help [COMMANDS]`
362
364
 
@@ -434,7 +436,7 @@ EXAMPLES
434
436
  $ flowcore logs adapter adapter-name -t tenant-name -s scenario-name --json
435
437
  ```
436
438
 
437
- _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v2.13.1/src/commands/logs/adapter.ts)_
439
+ _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.0/src/commands/logs/adapter.ts)_
438
440
 
439
441
  ## `flowcore new bun-service NAME`
440
442
 
@@ -460,7 +462,7 @@ EXAMPLES
460
462
  $ flowcore new bun-service my-service --no-flowcore
461
463
  ```
462
464
 
463
- _See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.2.0/src/commands/new/bun-service.ts)_
465
+ _See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.3.0/src/commands/new/bun-service.ts)_
464
466
 
465
467
  ## `flowcore new generator NAME`
466
468
 
@@ -483,7 +485,7 @@ EXAMPLES
483
485
  $ flowcore new generator my-generator
484
486
  ```
485
487
 
486
- _See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.2.0/src/commands/new/generator.ts)_
488
+ _See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.3.0/src/commands/new/generator.ts)_
487
489
 
488
490
  ## `flowcore new nextjs-app NAME`
489
491
 
@@ -506,7 +508,30 @@ EXAMPLES
506
508
  $ flowcore new nextjs-app my-app
507
509
  ```
508
510
 
509
- _See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.2.0/src/commands/new/nextjs-app.ts)_
511
+ _See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.3.0/src/commands/new/nextjs-app.ts)_
512
+
513
+ ## `flowcore new plugin NAME`
514
+
515
+ Create a new plugin
516
+
517
+ ```
518
+ USAGE
519
+ $ flowcore new plugin NAME [--profile <value>]
520
+
521
+ ARGUMENTS
522
+ NAME name of the plugin
523
+
524
+ FLAGS
525
+ --profile=<value> Specify the configuration profile to use
526
+
527
+ DESCRIPTION
528
+ Create a new plugin
529
+
530
+ EXAMPLES
531
+ $ flowcore new plugin my-plugin
532
+ ```
533
+
534
+ _See code: [@flowcore/cli-plugin-generator](https://github.com/flowcore/flowcore-cli-plugin-generator/blob/v1.3.0/src/commands/new/plugin.ts)_
510
535
 
511
536
  ## `flowcore plugins`
512
537
 
@@ -830,7 +855,7 @@ EXAMPLES
830
855
  $ flowcore reset adapter adapter-name -t tenant-name -s scenario-name -e 9cb35da2-ba64-4bb5-86d6-ef20ebc62ab7
831
856
  ```
832
857
 
833
- _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v2.13.1/src/commands/reset/adapter.ts)_
858
+ _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.0/src/commands/reset/adapter.ts)_
834
859
 
835
860
  ## `flowcore scenario apply`
836
861
 
@@ -860,7 +885,7 @@ EXAMPLES
860
885
  $ cat <<EOF | flowcore scenario apply -f -
861
886
  ```
862
887
 
863
- _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v2.13.1/src/commands/scenario/apply.ts)_
888
+ _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.0/src/commands/scenario/apply.ts)_
864
889
 
865
890
  ## `flowcore scenario generate manifest`
866
891
 
@@ -892,7 +917,7 @@ EXAMPLES
892
917
  $ flowcore scenario generate manifest -t flowcore -n scenario-name -f example.yaml
893
918
  ```
894
919
 
895
- _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v2.13.1/src/commands/scenario/generate/manifest.ts)_
920
+ _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.0/src/commands/scenario/generate/manifest.ts)_
896
921
 
897
922
  ## `flowcore scenario generate transformer`
898
923
 
@@ -919,7 +944,7 @@ EXAMPLES
919
944
  $ flowcore scenario generate transformer -n flow-type-name -d "description of the transformer" -f example.yaml
920
945
  ```
921
946
 
922
- _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v2.13.1/src/commands/scenario/generate/transformer.ts)_
947
+ _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.0/src/commands/scenario/generate/transformer.ts)_
923
948
 
924
949
  ## `flowcore scenario local`
925
950
 
@@ -951,16 +976,58 @@ EXAMPLES
951
976
  $ cat <<EOF | flowcore scenario local -f -
952
977
  ```
953
978
 
954
- _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v2.13.1/src/commands/scenario/local.ts)_
979
+ _See code: [@flowcore/cli-plugin-scenario](https://github.com/flowcore/flowcore-cli-plugin-scenario/blob/v3.0.0/src/commands/scenario/local.ts)_
955
980
 
956
981
  ## `flowcore stream STREAM`
957
982
 
958
- 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
959
984
 
960
985
  ```
961
986
  USAGE
962
- $ flowcore stream STREAM [--profile <value>] [-e <value>] [-j] [-l] [-m <value>] [-o http|log] [-p] [-c]
963
- [-s <value>] [-d <value>] [-H <value>] [-t <value>]
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>]
964
1031
 
965
1032
  ARGUMENTS
966
1033
  STREAM stream url to connect to
@@ -973,31 +1040,27 @@ FLAGS
973
1040
  -j, --json Output json only
974
1041
  -l, --[no-]live Change to live mode when reaching last time bucket
975
1042
  -m, --max=<value> Maximum number of events to send to the destination
976
- -o, --output=<option> [default: http] Output format
977
- <options: http|log>
978
1043
  -p, --payload Only send the event payload to the destination
979
1044
  -s, --start=<value> Start time bucket to stream from, example: (2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now)
980
1045
  -t, --timeout=<value> [default: 5000] Timeout in milliseconds to wait for a response from the destination
981
1046
  --profile=<value> Specify the configuration profile to use
982
1047
 
983
1048
  DESCRIPTION
984
- 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
985
1050
 
986
1051
  EXAMPLES
987
- $ 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
988
1053
 
989
- $ 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
990
1055
 
991
- $ flowcore stream "https://flowcore.io/<org>/<data core>/*" -s 1y
992
-
993
- $ 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
994
1057
 
995
- $ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -o log -s 3m --json > some.json
1058
+ $ flowcore stream http "https://flowcore.io/<org>/<data core>/<flow type>/*" -s 1y -d http://localhost:3000/transform
996
1059
 
997
- $ flowcore stream "https://flowcore.io/<org>/<data core>/<flow type>/[<event type1>,<event type2>,<event type3>].stream" -o log -s 3m
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
998
1061
  ```
999
1062
 
1000
- _See code: [@flowcore/cli-plugin-core](https://github.com/flowcore/flowcore-cli-plugin-core/blob/v1.6.2/src/commands/stream.ts)_
1063
+ _See code: [@flowcore/cli-plugin-core](https://github.com/flowcore/flowcore-cli-plugin-core/blob/v2.0.0/src/commands/stream/http.ts)_
1001
1064
 
1002
1065
  ## `flowcore version`
1003
1066
 
@@ -48,5 +48,5 @@
48
48
  ]
49
49
  }
50
50
  },
51
- "version": "2.21.0"
51
+ "version": "3.0.0"
52
52
  }
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": "^1.6.2",
9
+ "@flowcore/cli-plugin-core": "^2.0.0",
10
10
  "@flowcore/cli-plugin-data-core": "^2.2.2",
11
- "@flowcore/cli-plugin-generator": "^1.2.0",
12
- "@flowcore/cli-plugin-scenario": "^2.13.1",
11
+ "@flowcore/cli-plugin-generator": "^1.3.0",
12
+ "@flowcore/cli-plugin-scenario": "^3.0.0",
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": "2.21.0",
103
+ "version": "3.0.0",
100
104
  "bugs": "https://github.com/flowcore-io/flowcore-cli/issues",
101
105
  "keywords": [
102
106
  "flowcore",