Flowcore CLI Plugin - Core
=================

Core cli plugin, contains the core building blocks for the Flowcore CLI


* Usage
* Commands

Usage

``sh-session
$ npm install -g @flowcore/cli-plugin-core
$ core COMMAND
running command...
$ core (--version)
@flowcore/cli-plugin-core/4.1.1 darwin-arm64 node-v20.15.0
$ core --help [COMMAND]
USAGE
$ core COMMAND
...
`

Commands

* core stream STREAM
* core stream http STREAM

core stream STREAM

Stream events from a datacore running on the Flowcore Platform and output them to the console

`
USAGE
$ core stream STREAM [-e ] [-j] [-l] [-m ] [-p] [-c] [-s ] [--profile ]

ARGUMENTS
STREAM stream url to connect to

FLAGS
-c, --scan Scan the full time range
-e, --end= End time to stream to, example: 2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now
-j, --json Output json only
-l, --[no-]live Change to live mode when reaching last time bucket
-m, --max= Maximum number of events to send to the destination
-p, --payload Only send the event payload to the destination
-s, --start= Start time bucket to stream from, example: (2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now)
--profile= Specify the configuration profile to use

DESCRIPTION
Stream events from a datacore running on the Flowcore Platform and output them to the console

EXAMPLES
$ core stream "https://flowcore.io////.stream"

$ core stream "https://flowcore.io////.stream" -s 1y

$ core stream "https://flowcore.io///*" -s 1y

$ core stream "https://flowcore.io////*" -s 1y

$ core stream "https://flowcore.io////.stream" -s 3m --json > some.json

$ core stream "https://flowcore.io////[,,].stream" -s 3m
`

_See code: src/commands/stream.ts_

core stream http STREAM

Stream events from a datacore running on the Flowcore Platform and stream to a http endpoint

`
USAGE
$ core stream http STREAM [-e ] [-j] [-l] [-m ] [-p] [-c] [-s ] [--profile ] [-d
] [-H ...] [-t ]

ARGUMENTS
STREAM stream url to connect to

FLAGS
-H, --header=... [default: ] header to send with the request, example: (-H 'Authorization: Bearer TOKEN')
-c, --scan Scan the full time range
-d, --destination= [default: http://localhost:3000/transform] Destination to send events to
-e, --end= End time to stream to, example: 2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now
-j, --json Output json only
-l, --[no-]live Change to live mode when reaching last time bucket
-m, --max= Maximum number of events to send to the destination
-p, --payload Only send the event payload to the destination
-s, --start= Start time bucket to stream from, example: (2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now)
-t, --timeout= [default: 5000] Timeout in milliseconds to wait for a response from the destination
--profile= Specify the configuration profile to use

DESCRIPTION
Stream events from a datacore running on the Flowcore Platform and stream to a http endpoint

EXAMPLES
$ core stream http "https://flowcore.io////.stream" -d http://localhost:3000/transform

$ core stream http "https://flowcore.io////.stream" -s 1y -d http://localhost:3000/transform

$ core stream http "https://flowcore.io///*" -s 1y -d http://localhost:3000/transform

$ core stream http "https://flowcore.io////*" -s 1y -d http://localhost:3000/transform

$ core stream http "https://flowcore.io////[,,].stream" -s 3m -d http://localhost:3000/transform
``

_See code: src/commands/stream/http.ts_