Flowcore CLI Plugin - Core

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

• Usage
• Commands

Usage

$ npm install -g @flowcore/cli-plugin-core
$ core COMMAND
running command...
$ core (--version)
@flowcore/cli-plugin-core/5.7.0 linux-x64 node-v20.16.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 <value>] [-j] [-l] [-m <value>] [-p] [-c] [-s <value>] [-z <value>] [-i] [-x
    <value>] [-b <value>] [--profile <value>]

ARGUMENTS
  STREAM  stream url to connect to

FLAGS
  -b, --bufferSize=<value>    Buffer size for event processing
  -c, --scan                  Scan the full time range
  -e, --end=<value>           End time to stream to, example: 2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now
  -i, --includeSensitiveData  Include sensitive data in the output
  -j, --json                  Output json only
  -l, --[no-]live             Change to live mode when reaching last time bucket
  -m, --max=<value>           Maximum number of events to send to the destination
  -p, --payload               Only send the event payload to the destination
  -s, --start=<value>         Start time bucket to stream from, example: (2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now)
  -x, --concurrency=<value>   [default: 1] Number of events to process concurrently
  -z, --pageSize=<value>      [default: 10000] Number of events to fetch per page
      --profile=<value>       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/<org>/<data core>/<flow type>/<event type>.stream"

  $ core stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s 1y

  $ core stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s first

  $ core stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s now

  $ core stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s first -i

  $ core stream "https://flowcore.io/<org>/<data core>/*" -s 1y

  $ core stream "https://flowcore.io/<org>/<data core>/<flow type>/*" -s 1y

  $ core stream "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s 3m --json > some.json

  $ core stream "https://flowcore.io/<org>/<data core>/<flow type>/[<event type1>,<event type2>,<event type3>].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 <value>] [-j] [-l] [-m <value>] [-p] [-c] [-s <value>] [-z <value>] [-i] [-x
    <value>] [-b <value>] [--profile <value>] [-d <value>] [-H <value>...] [-t <value>]

ARGUMENTS
  STREAM  stream url to connect to

FLAGS
  -H, --header=<value>...     [default: ] header to send with the request, example: (-H 'Authorization: Bearer TOKEN')
  -b, --bufferSize=<value>    Buffer size for event processing
  -c, --scan                  Scan the full time range
  -d, --destination=<value>   [default: http://localhost:3000/transform] Destination to send events to
  -e, --end=<value>           End time to stream to, example: 2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now
  -i, --includeSensitiveData  Include sensitive data in the output
  -j, --json                  Output json only
  -l, --[no-]live             Change to live mode when reaching last time bucket
  -m, --max=<value>           Maximum number of events to send to the destination
  -p, --payload               Only send the event payload to the destination
  -s, --start=<value>         Start time bucket to stream from, example: (2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now)
  -t, --timeout=<value>       [default: 5000] Timeout in milliseconds to wait for a response from the destination
  -x, --concurrency=<value>   [default: 1] Number of events to process concurrently
  -z, --pageSize=<value>      [default: 10000] Number of events to fetch per page
      --profile=<value>       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/<org>/<data core>/<flow type>/<event type>.stream" -d http://localhost:3000/transform

  $ core stream http "https://flowcore.io/<org>/<data core>/<flow type>/<event type>.stream" -s 1y -d http://localhost:3000/transform

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

  $ core stream http "https://flowcore.io/<org>/<data core>/<flow type>/*" -s 1y -d http://localhost:3000/transform

  $ core stream http "https://flowcore.io/<org>/<data core>/<flow type>/[<event type1>,<event type2>,<event type3>].stream" -s 3m -d http://localhost:3000/transform

See code: src/commands/stream/http.ts