https://github.com/flowcore-io/flowcore-cli-plugin-export-jsonl
https://github.com/flowcore-io/flowcore-cli-plugin-export-jsonl
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/flowcore-io/flowcore-cli-plugin-export-jsonl
- Owner: flowcore-io
- Created: 2024-08-28T22:05:14.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T23:29:56.000Z (almost 2 years ago)
- Last Synced: 2025-10-24T03:49:27.592Z (8 months ago)
- Language: TypeScript
- Size: 149 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
Flowcore CLI Plugin - Export Jsonl
=================
Export data as jsonl files
[](https://npmjs.org/package/@flowcore/flowcore-cli-plugin-export-jsonl)
[](https://oclif.io)
* [Usage](#usage)
* [Commands](#commands)
# Installation
```bash
$ flowcore plugins install https://github.com/flowcore-io/flowcore-cli-plugin-export-jsonl
```
# Usage
```sh-session
$ flowcore export jsonl --help
```
# Commands
* [`export jsonl`](#export-jsonl)
## `export jsonl`
Export data as jsonl
```
USAGE
$ flowcore export jsonl STREAM -n [--profile ] [-e ] [-j] [-l] [-m ] [-o http|log|jsonl] [-p] [-c] [-s ] [-d] [-f ] [--timeBucketSplitLength ]
ARGUMENTS
STREAM stream url to connect to
FLAGS
-c, --scan Scan the full time range
-d, --dataOnly Only send the event data to the destination
-e, --end= End time to stream to, example: 2024-07-08T12:20:44Z, 1y, 1m, 1w, 1d, 1h, now
-f, --outputFolder= [default: ./jsonl_files] Folder to write jsonl files to
-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
-n, --tenant= (required) Tenant to stream from
-o, --output= [default: jsonl] Output format
-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
--timeBucketSplitLength= [default: 8] Split files by time, number of digits to use in timebucket key
DESCRIPTION
Stream events from a datacore running on the Flowcore Platform and save the data in jsonl files
EXAMPLES
$ flowcore export jsonl "https://flowcore.io////.stream" -s 1m -e 1h --tenant --outputFolder ./jsonl_files
```
_See code: [src/commands/export/jsonl.ts](https://github.com/flowcore-io/flowcore-cli-plugin-export-jsonl/blob/main/src/commands/export/jsonl.ts)_