Flowcore CLI Plugin - Data Core

A Flowcore CLI plugin for working with Data Cores in the Flowcore Platform

• Usage
• Commands

Usage

$ npm install -g @flowcore/cli-plugin-data-core
$ data-core COMMAND
running command...
$ data-core (--version)
@flowcore/cli-plugin-data-core/3.3.1 linux-x64 node-v20.16.0
$ data-core --help [COMMAND]
USAGE
  $ data-core COMMAND
...

Commands

• data-core data-core apply
• data-core data-core generate event-type FLOWTYPE
• data-core data-core generate flow-type
• data-core data-core init

data-core data-core apply

Apply a manifest configuration for a Data Core to the Flowcore Platform

USAGE
  $ data-core data-core apply -f <value>... [--profile <value>] [-n <value>] [-t <value>] [-y]

FLAGS
  -f, --file=<value>...  (required) file to apply
  -n, --name=<value>     name of the data core to apply
  -t, --tenant=<value>   tenant to apply the data core to, this is the org for your organization, it can be seen in the
                         url when accessing your organization
  -y, --yes              skip confirmation
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Apply a manifest configuration for a Data Core to the Flowcore Platform

EXAMPLES
  $ data-core data-core apply -t flowcore -f example.yaml

  $ data-core data-core apply -t flowcore -n data-core-name -f example.yaml

  $ cat <<EOF | data-core data-core apply -f -

See code: src/commands/data-core/apply.ts

data-core data-core generate event-type FLOWTYPE

add a event type to a data core manifest

USAGE
  $ data-core data-core generate event-type FLOWTYPE [--profile <value>] [-d <value>] [-f <value>] [-n <value>]

FLAGS
  -d, --description=<value>  description of the event type
  -f, --file=<value>         [default: flowcore.yaml] file to modify
  -n, --name=<value>         name of the event type to generate
      --profile=<value>      Specify the configuration profile to use

DESCRIPTION
  add a event type to a data core manifest

EXAMPLES
  $ data-core data-core generate event-type flow-type-name -n event-type-name

  $ data-core data-core generate event-type flow-type-name -n event-type-name -d "description of the event type"

  $ data-core data-core generate event-type flow-type-name -n event-type-name -d "description of the event type" -f example.yaml

See code: src/commands/data-core/generate/event-type.ts

data-core data-core generate flow-type

add a flow type to a data core manifest

USAGE
  $ data-core data-core generate flow-type [--profile <value>] [-d <value>] [-f <value>] [-n <value>]

FLAGS
  -d, --description=<value>  description of the flow type
  -f, --file=<value>         [default: flowcore.yaml] file to modify
  -n, --name=<value>         name of the flow type to generate
      --profile=<value>      Specify the configuration profile to use

DESCRIPTION
  add a flow type to a data core manifest

EXAMPLES
  $ data-core data-core generate flow-type -n flow-type-name

  $ data-core data-core generate flow-type -n flow-type-name -d "description of the flow type"

  $ data-core data-core generate flow-type -n flow-type-name -d "description of the flow type" -f example.yaml

See code: src/commands/data-core/generate/flow-type.ts

data-core data-core init

Initialize a data core manifest

USAGE
  $ data-core data-core init -t <value> [--profile <value>] [-f <value>] [-p] [-o]

FLAGS
  -f, --file=<value>     [default: flowcore.yaml] filename it will be created with, defaults to flowcore.yaml
  -o, --overwrite        overwrite the existing data core
  -p, --no-placeholders  use placeholders for the data core
  -t, --tenant=<value>   (required) tenant to apply the data core to, this is the org for your organization, it can be
                         seen in the url when accessing your organization
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Initialize a data core manifest

EXAMPLES
  $ data-core data-core init -t flowcore

  $ data-core data-core init -t flowcore --placeholder

  $ data-core data-core init -t flowcore -f example.yaml

  $ data-core data-core init -t flowcore -n data-core-name -f example.yaml

See code: src/commands/data-core/init.ts