npm package: @flowcore/cli-plugin-data-core
Description: A Flowcore CLI plugin for working with Data Cores in the Flowcore Platform
Author: flowcore-platform
Latest version: 3.5.2

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

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

[![Version](https://img.shields.io/npm/v/@flowcore/flowcore-cli-plugin-data-core)](https://npmjs.org/package/@flowcore/flowcore-cli-plugin-data-core)
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Build and Release](https://github.com/@flowcore/flowcore-cli-plugin-data-core/actions/workflows/build.yml/badge.svg)](https://github.com/@flowcore/flowcore-cli-plugin-data-core/actions/workflows/build.yml)

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ npm install -g @flowcore/cli-plugin-data-core
$ data-core COMMAND
running command...
$ data-core (--version)
@flowcore/cli-plugin-data-core/3.5.2 linux-x64 node-v20.20.0
$ data-core --help [COMMAND]
USAGE
  $ data-core COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`data-core data-core apply`](#data-core-data-core-apply)
* [`data-core data-core create NAME`](#data-core-data-core-create-name)
* [`data-core data-core delete NAME`](#data-core-data-core-delete-name)
* [`data-core data-core generate event-type FLOWTYPE`](#data-core-data-core-generate-event-type-flowtype)
* [`data-core data-core generate flow-type`](#data-core-data-core-generate-flow-type)
* [`data-core data-core get NAME`](#data-core-data-core-get-name)
* [`data-core data-core init`](#data-core-data-core-init)
* [`data-core data-core list`](#data-core-data-core-list)
* [`data-core data-core update NAME`](#data-core-data-core-update-name)
* [`data-core event-type create NAME`](#data-core-event-type-create-name)
* [`data-core event-type delete NAME`](#data-core-event-type-delete-name)
* [`data-core event-type get NAME`](#data-core-event-type-get-name)
* [`data-core event-type list`](#data-core-event-type-list)
* [`data-core event-type update NAME`](#data-core-event-type-update-name)
* [`data-core flow-type create NAME`](#data-core-flow-type-create-name)
* [`data-core flow-type delete NAME`](#data-core-flow-type-delete-name)
* [`data-core flow-type get NAME`](#data-core-flow-type-get-name)
* [`data-core flow-type list`](#data-core-flow-type-list)
* [`data-core flow-type update NAME`](#data-core-flow-type-update-name)

## `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](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/data-core/apply.ts)_

## `data-core data-core create NAME`

Create a new data core

```
USAGE
  $ data-core data-core create NAME -t <value> [--profile <value>] [--delete-protection] [-d <value>] [-j] [--public]

ARGUMENTS
  NAME  name of the data core

FLAGS
  -d, --description=<value>  description of the data core
  -j, --json                 output as JSON
  -t, --tenant=<value>       (required) tenant name
      --delete-protection    enable delete protection
      --profile=<value>      Specify the configuration profile to use
      --public               make the data core public

DESCRIPTION
  Create a new data core

EXAMPLES
  $ data-core data-core create my-data-core -t my-tenant

  $ data-core data-core create my-data-core -t my-tenant -d "My description" --public
```

_See code: [src/commands/data-core/create.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/data-core/create.ts)_

## `data-core data-core delete NAME`

Delete a data core

```
USAGE
  $ data-core data-core delete NAME -t <value> [--profile <value>] [--wait] [-y]

ARGUMENTS
  NAME  name of the data core

FLAGS
  -t, --tenant=<value>   (required) tenant name
  -y, --yes              skip confirmation
      --profile=<value>  Specify the configuration profile to use
      --[no-]wait        wait for deletion to complete

DESCRIPTION
  Delete a data core

EXAMPLES
  $ data-core data-core delete my-data-core -t my-tenant

  $ data-core data-core delete my-data-core -t my-tenant -y
```

_See code: [src/commands/data-core/delete.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/data-core/delete.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](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/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](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/data-core/generate/flow-type.ts)_

## `data-core data-core get NAME`

Get a data core by name

```
USAGE
  $ data-core data-core get NAME -t <value> [--profile <value>] [-j]

ARGUMENTS
  NAME  name of the data core

FLAGS
  -j, --json             output as JSON
  -t, --tenant=<value>   (required) tenant name
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  Get a data core by name

EXAMPLES
  $ data-core data-core get my-data-core -t my-tenant

  $ data-core data-core get my-data-core -t my-tenant -j
```

_See code: [src/commands/data-core/get.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/data-core/get.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](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/data-core/init.ts)_

## `data-core data-core list`

List all data cores for a tenant

```
USAGE
  $ data-core data-core list -t <value> [--profile <value>] [-j]

FLAGS
  -j, --json             output as JSON
  -t, --tenant=<value>   (required) tenant name
      --profile=<value>  Specify the configuration profile to use

DESCRIPTION
  List all data cores for a tenant

EXAMPLES
  $ data-core data-core list -t my-tenant

  $ data-core data-core list -t my-tenant -j
```

_See code: [src/commands/data-core/list.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/data-core/list.ts)_

## `data-core data-core update NAME`

Update a data core

```
USAGE
  $ data-core data-core update NAME -t <value> [--profile <value>] [--delete-protection] [-d <value>] [-j] [--public]

ARGUMENTS
  NAME  name of the data core

FLAGS
  -d, --description=<value>     description of the data core
  -j, --json                    output as JSON
  -t, --tenant=<value>          (required) tenant name
      --[no-]delete-protection  enable delete protection
      --profile=<value>         Specify the configuration profile to use
      --[no-]public             make the data core public

DESCRIPTION
  Update a data core

EXAMPLES
  $ data-core data-core update my-data-core -t my-tenant -d "New description"

  $ data-core data-core update my-data-core -t my-tenant --public --delete-protection
```

_See code: [src/commands/data-core/update.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/data-core/update.ts)_

## `data-core event-type create NAME`

Create a new event type

```
USAGE
  $ data-core event-type create NAME --data-core <value> --flow-type <value> -t <value> [--profile <value>] [-d
    <value>] [-j]

ARGUMENTS
  NAME  name of the event type

FLAGS
  -d, --description=<value>  description of the event type
  -j, --json                 output as JSON
  -t, --tenant=<value>       (required) tenant name
      --data-core=<value>    (required) name of the data core
      --flow-type=<value>    (required) name of the flow type
      --profile=<value>      Specify the configuration profile to use

DESCRIPTION
  Create a new event type

EXAMPLES
  $ data-core event-type create my-event-type --data-core my-dc --flow-type my-ft -t my-tenant

  $ data-core event-type create my-event-type --data-core my-dc --flow-type my-ft -t my-tenant -d "My description"
```

_See code: [src/commands/event-type/create.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/event-type/create.ts)_

## `data-core event-type delete NAME`

Delete an event type

```
USAGE
  $ data-core event-type delete NAME --data-core <value> --flow-type <value> -t <value> [--profile <value>] [--wait]
    [-y]

ARGUMENTS
  NAME  name of the event type

FLAGS
  -t, --tenant=<value>     (required) tenant name
  -y, --yes                skip confirmation
      --data-core=<value>  (required) name of the data core
      --flow-type=<value>  (required) name of the flow type
      --profile=<value>    Specify the configuration profile to use
      --[no-]wait          wait for deletion to complete

DESCRIPTION
  Delete an event type

EXAMPLES
  $ data-core event-type delete my-event-type --data-core my-dc --flow-type my-ft -t my-tenant

  $ data-core event-type delete my-event-type --data-core my-dc --flow-type my-ft -t my-tenant -y
```

_See code: [src/commands/event-type/delete.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/event-type/delete.ts)_

## `data-core event-type get NAME`

Get an event type by name

```
USAGE
  $ data-core event-type get NAME --data-core <value> --flow-type <value> -t <value> [--profile <value>] [-j]

ARGUMENTS
  NAME  name of the event type

FLAGS
  -j, --json               output as JSON
  -t, --tenant=<value>     (required) tenant name
      --data-core=<value>  (required) name of the data core
      --flow-type=<value>  (required) name of the flow type
      --profile=<value>    Specify the configuration profile to use

DESCRIPTION
  Get an event type by name

EXAMPLES
  $ data-core event-type get my-event-type --data-core my-dc --flow-type my-ft -t my-tenant
```

_See code: [src/commands/event-type/get.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/event-type/get.ts)_

## `data-core event-type list`

List all event types for a flow type

```
USAGE
  $ data-core event-type list --data-core <value> --flow-type <value> -t <value> [--profile <value>] [-j]

FLAGS
  -j, --json               output as JSON
  -t, --tenant=<value>     (required) tenant name
      --data-core=<value>  (required) name of the data core
      --flow-type=<value>  (required) name of the flow type
      --profile=<value>    Specify the configuration profile to use

DESCRIPTION
  List all event types for a flow type

EXAMPLES
  $ data-core event-type list --data-core my-dc --flow-type my-ft -t my-tenant

  $ data-core event-type list --data-core my-dc --flow-type my-ft -t my-tenant -j
```

_See code: [src/commands/event-type/list.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/event-type/list.ts)_

## `data-core event-type update NAME`

Update an event type

```
USAGE
  $ data-core event-type update NAME --data-core <value> -d <value> --flow-type <value> -t <value> [--profile <value>]
    [-j]

ARGUMENTS
  NAME  name of the event type

FLAGS
  -d, --description=<value>  (required) description of the event type
  -j, --json                 output as JSON
  -t, --tenant=<value>       (required) tenant name
      --data-core=<value>    (required) name of the data core
      --flow-type=<value>    (required) name of the flow type
      --profile=<value>      Specify the configuration profile to use

DESCRIPTION
  Update an event type

EXAMPLES
  $ data-core event-type update my-event-type --data-core my-dc --flow-type my-ft -t my-tenant -d "New description"
```

_See code: [src/commands/event-type/update.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/event-type/update.ts)_

## `data-core flow-type create NAME`

Create a new flow type

```
USAGE
  $ data-core flow-type create NAME --data-core <value> -t <value> [--profile <value>] [-d <value>] [-j]

ARGUMENTS
  NAME  name of the flow type

FLAGS
  -d, --description=<value>  description of the flow type
  -j, --json                 output as JSON
  -t, --tenant=<value>       (required) tenant name
      --data-core=<value>    (required) name of the data core
      --profile=<value>      Specify the configuration profile to use

DESCRIPTION
  Create a new flow type

EXAMPLES
  $ data-core flow-type create my-flow-type --data-core my-dc -t my-tenant

  $ data-core flow-type create my-flow-type --data-core my-dc -t my-tenant -d "My description"
```

_See code: [src/commands/flow-type/create.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/flow-type/create.ts)_

## `data-core flow-type delete NAME`

Delete a flow type

```
USAGE
  $ data-core flow-type delete NAME --data-core <value> -t <value> [--profile <value>] [--wait] [-y]

ARGUMENTS
  NAME  name of the flow type

FLAGS
  -t, --tenant=<value>     (required) tenant name
  -y, --yes                skip confirmation
      --data-core=<value>  (required) name of the data core
      --profile=<value>    Specify the configuration profile to use
      --[no-]wait          wait for deletion to complete

DESCRIPTION
  Delete a flow type

EXAMPLES
  $ data-core flow-type delete my-flow-type --data-core my-dc -t my-tenant

  $ data-core flow-type delete my-flow-type --data-core my-dc -t my-tenant -y
```

_See code: [src/commands/flow-type/delete.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/flow-type/delete.ts)_

## `data-core flow-type get NAME`

Get a flow type by name

```
USAGE
  $ data-core flow-type get NAME --data-core <value> -t <value> [--profile <value>] [-j]

ARGUMENTS
  NAME  name of the flow type

FLAGS
  -j, --json               output as JSON
  -t, --tenant=<value>     (required) tenant name
      --data-core=<value>  (required) name of the data core
      --profile=<value>    Specify the configuration profile to use

DESCRIPTION
  Get a flow type by name

EXAMPLES
  $ data-core flow-type get my-flow-type --data-core my-dc -t my-tenant
```

_See code: [src/commands/flow-type/get.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/flow-type/get.ts)_

## `data-core flow-type list`

List all flow types for a data core

```
USAGE
  $ data-core flow-type list --data-core <value> -t <value> [--profile <value>] [-j]

FLAGS
  -j, --json               output as JSON
  -t, --tenant=<value>     (required) tenant name
      --data-core=<value>  (required) name of the data core
      --profile=<value>    Specify the configuration profile to use

DESCRIPTION
  List all flow types for a data core

EXAMPLES
  $ data-core flow-type list --data-core my-dc -t my-tenant

  $ data-core flow-type list --data-core my-dc -t my-tenant -j
```

_See code: [src/commands/flow-type/list.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/flow-type/list.ts)_

## `data-core flow-type update NAME`

Update a flow type

```
USAGE
  $ data-core flow-type update NAME --data-core <value> -d <value> -t <value> [--profile <value>] [-j]

ARGUMENTS
  NAME  name of the flow type

FLAGS
  -d, --description=<value>  (required) description of the flow type
  -j, --json                 output as JSON
  -t, --tenant=<value>       (required) tenant name
      --data-core=<value>    (required) name of the data core
      --profile=<value>      Specify the configuration profile to use

DESCRIPTION
  Update a flow type

EXAMPLES
  $ data-core flow-type update my-flow-type --data-core my-dc -t my-tenant -d "New description"
```

_See code: [src/commands/flow-type/update.ts](https://github.com/flowcore/flowcore-cli-data-core/blob/v3.5.2/src/commands/flow-type/update.ts)_
<!-- commandsstop -->