Evently Command Line Interface

This package contains the source code for the evently command line interface. The commands use the Evently REST API directly and provide convenient access to the ledger’s contents.

The CLI’s bin name is evently and can be used from your terminal. To learn more about the available commands, run the help command:

Installation

The easiest is way to use this is to install it globally with npm:

npm install --global @evently-cloud/cli

This requires Node being installed on your system.

For one-off uses you can also use the npx command to use the cli:

npx @evently-cloud/cli

Authenticating

Most evently commands will need the API access token in order to function. You can request one via the form on evently.cloud.

After you obtained the token, you can either pass it to every command using the -t option, but you are recommended to set it via the EVENTLY_TOKEN environment variable instead.

For example, you can add the following statement to your .bash_profile or .zshrc:

export EVENTLY_TOKEN="your-token-here"

Commands

evently append:atomic
evently append:fact
evently append:serial
evently commands
evently help [COMMANDS]
evently ledger
evently ledger:download
evently ledger:reset
evently registry:delete
evently registry:list-entities
evently registry:list-events
evently registry:new
evently selector:filter
evently selector:replay
evently selector:selector-command
evently selector:table

`evently append:atomic`

Appends a serial event to the ledger

USAGE
  $ evently append:atomic [-t <value>] [-f <value>] [-b <value>]

FLAGS
  -b, --body=<value>   Read data from argument. If neither --body nor --file is given, STDIN is used.
  -f, --file=<value>   Read event data from this file. If neither --body nor --file is given, STDIN is used.
  -t, --token=<value>  [default: NOT-SET] Access token for your ledger.

DESCRIPTION
  Appends a serial event to the ledger

EXAMPLES
  $ evently append:atomic <<EVENT
  {
    entity: "thermostat",
    event: "temperature-recorded",
    key: "thermostat1",
    meta: {causation: "14rew3494"},
    data:{celsius: 18.5},
    selector: {
      selectorId: "foo",
      mark: "bar"
    }
  }
  EVENT
  Created new event at: https://preview.evently.cloud/selectors/fetch/ijfoij2oip4gj4wd.json

See code: dist/commands/append/atomic.ts

`evently append:fact`

Appends a factual event to the ledger

USAGE
  $ evently append:fact [-t <value>] [-f <value>] [-b <value>]

FLAGS
  -b, --body=<value>   Read data from argument. If neither --body nor --file is given, STDIN is used.
  -f, --file=<value>   Read event data from this file. If neither --body nor --file is given, STDIN is used.
  -t, --token=<value>  [default: NOT-SET] Access token for your ledger.

DESCRIPTION
  Appends a factual event to the ledger

EXAMPLES
  $ evently append:fact <<EVENT
  {
    entity: "thermostat",
    event: "temperature-recorded",
    key: "thermostat1",
    meta: {causation: "14rew3494"},
    data:{celsius: 18.5}
  }
  EVENT
  Created new event at: https://preview.evently.cloud/selectors/fetch/ijfoij2oip4gj4wd.json

See code: dist/commands/append/fact.ts

`evently append:serial`

Appends a serial event to the ledger

USAGE
  $ evently append:serial [-t <value>] [-f <value>] [-b <value>]

FLAGS
  -b, --body=<value>   Read data from argument. If neither --body nor --file is given, STDIN is used.
  -f, --file=<value>   Read event data from this file. If neither --body nor --file is given, STDIN is used.
  -t, --token=<value>  [default: NOT-SET] Access token for your ledger.

DESCRIPTION
  Appends a serial event to the ledger

EXAMPLES
  $ evently append:serial <<EVENT
  {
    entity: "thermostat",
    event: "temperature-recorded",
    key: "thermostat1",
    meta: {causation: "14rew3494"},
    data:{celsius: 18.5},
    previousEventId: "foo-bar"
  }
  EVENT
  Created new event at: https://preview.evently.cloud/selectors/fetch/ijfoij2oip4gj4wd.json

See code: dist/commands/append/serial.ts

`evently commands`

list all the commands

USAGE
  $ evently commands [--json] [-h] [--hidden] [--tree] [--columns <value> | -x] [--sort <value>] [--filter
    <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -h, --help         Show CLI help.
  -x, --extended     show extra columns
  --columns=<value>  only show provided columns (comma-separated)
  --csv              output is csv format [alias: --output=csv]
  --filter=<value>   filter property by partial string matching, ex: name=foo
  --hidden           show hidden commands
  --no-header        hide table header from output
  --no-truncate      do not truncate output to fit screen
  --output=<option>  output in a more machine friendly format
                     <options: csv|json|yaml>
  --sort=<value>     property to sort by (prepend '-' for descending)
  --tree             show tree of commands

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  list all the commands

See code: @oclif/plugin-commands

`evently help [COMMANDS]`

Display help for evently.

USAGE
  $ evently help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for evently.

See code: @oclif/plugin-help

`evently ledger`

Ledger commands

USAGE
  $ evently ledger [-t <value>]

FLAGS
  -t, --token=<value>  [default: NOT-SET] Access token for your ledger.

DESCRIPTION
  Ledger commands

EXAMPLES
  $ evently ledger
  name: your-ledger-name, events: count

See code: dist/commands/ledger/index.ts

`evently ledger:download`

Download a Ledger

USAGE
  $ evently ledger:download -f <value> [-t <value>]

FLAGS
  -f, --file=<value>   (required) File to download / append Ledger to.
  -t, --token=<value>  [default: NOT-SET] Access token for your ledger.

DESCRIPTION
  Download a Ledger

EXAMPLES
  $ evently ledger:download
  Validated 13,438 ledger events.

See code: dist/commands/ledger/download.ts

`evently ledger:reset`

Reset a Ledger

USAGE
  $ evently ledger:reset [-t <value>] [-a <value>]

FLAGS
  -a, --after=<value>  Ledger Mark / Event ID to reset ledger after.
  -t, --token=<value>  [default: NOT-SET] Access token for your ledger.

DESCRIPTION
  Reset a Ledger

EXAMPLES
  $ evently ledger:reset
  Reset ledger fully.

See code: dist/commands/ledger/reset.ts

`evently registry:delete`

Deletes an event type from the registry. This only works if no events of this type have been created.

USAGE
  $ evently registry:delete -e <value> -n <value> [-t <value>]

FLAGS
  -e, --event=<value>   (required) Event name
  -n, --entity=<value>  (required) Entity name
  -t, --token=<value>   [default: NOT-SET] Access token for your ledger.

DESCRIPTION
  Deletes an event type from the registry. This only works if no events of this type have been created.

EXAMPLES
  $ evently registry:delete -n article -e add-comment
  Deleted entity event type https://preview.evently.cloud/registry/article/add-comment

See code: dist/commands/registry/delete.ts

`evently registry:list-entities`

Lists all entities in the registry.

USAGE
  $ evently registry:list-entities [-t <value>] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
    csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -t, --token=<value>  [default: NOT-SET] Access token for your ledger.
  -x, --extended       show extra columns
  --columns=<value>    only show provided columns (comma-separated)
  --csv                output is csv format [alias: --output=csv]
  --filter=<value>     filter property by partial string matching, ex: name=foo
  --no-header          hide table header from output
  --no-truncate        do not truncate output to fit screen
  --output=<option>    output in a more machine friendly format
                       <options: csv|json|yaml>
  --sort=<value>       property to sort by (prepend '-' for descending)

DESCRIPTION
  Lists all entities in the registry.

EXAMPLES
  $ evently registry:list-entities

See code: dist/commands/registry/list-entities.ts

`evently registry:list-events`

Lists all event types for an entity.

USAGE
  $ evently registry:list-events -n <value> [-t <value>] [--columns <value> | -x] [--sort <value>] [--filter <value>]
    [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header | ]

FLAGS
  -n, --entity=<value>  (required) Entity name
  -t, --token=<value>   [default: NOT-SET] Access token for your ledger.
  -x, --extended        show extra columns
  --columns=<value>     only show provided columns (comma-separated)
  --csv                 output is csv format [alias: --output=csv]
  --filter=<value>      filter property by partial string matching, ex: name=foo
  --no-header           hide table header from output
  --no-truncate         do not truncate output to fit screen
  --output=<option>     output in a more machine friendly format
                        <options: csv|json|yaml>
  --sort=<value>        property to sort by (prepend '-' for descending)

DESCRIPTION
  Lists all event types for an entity.

EXAMPLES
  $ evently registry:list-events --entity my-entity

See code: dist/commands/registry/list-events.ts

`evently registry:new`

Creates a new entity event type.

USAGE
  $ evently registry:new -e <value> -n <value> [-t <value>]

FLAGS
  -e, --event=<value>   (required) Event name
  -n, --entity=<value>  (required) Entity name
  -t, --token=<value>   [default: NOT-SET] Access token for your ledger.

DESCRIPTION
  Creates a new entity event type.

EXAMPLES
  $ evently registry:new -n article -e add-comment
  Created entity event type at https://preview.evently.cloud/registry/article/add-comment

See code: dist/commands/registry/new.ts

`evently selector:filter`

Filter the ledger for matching events using JSONPath.

USAGE
  $ evently selector:filter [-t <value>] [--meta <value>] [--data <value>] [-a <value>] [-l <value>] [--columns
    <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header
    | ]

FLAGS
  -a, --after=<value>  Select events that occur after this ledger mark or event ID.
  -l, --limit=<value>  [default: 50] Limit the number of returned events to this value.
  -t, --token=<value>  [default: NOT-SET] Access token for your ledger.
  -x, --extended       show extra columns
  --columns=<value>    only show provided columns (comma-separated)
  --csv                output is csv format [alias: --output=csv]
  --data=<value>...    SQL JSONPath on the event's data object. This should be in the format "entity:event:jsonpath".
                       Only the last component may have colons itself.
  --filter=<value>     filter property by partial string matching, ex: name=foo
  --meta=<value>       SQL JSONPath on the event's meta object
  --no-header          hide table header from output
  --no-truncate        do not truncate output to fit screen
  --output=<option>    output in a more machine friendly format
                       <options: csv|json|yaml>
  --sort=<value>       property to sort by (prepend '-' for descending)

DESCRIPTION
  Filter the ledger for matching events using JSONPath.

EXAMPLES
  $ evently selector:filter       article:add-comment:\"$\"

  $ evently selector:replay   article:add-comment:\"$\",
    --limit 10

See code: dist/commands/selector/filter.ts

`evently selector:replay`

Replay an entities events.

USAGE
  $ evently selector:replay -n <value> -k <value> [-t <value>] [-e <value>] [-a <value>] [-l <value>] [--columns
    <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml |  | [--csv | --no-truncate]] [--no-header
    | ]

FLAGS
  -a, --after=<value>     Select events that occur after this ledger mark or event ID.
  -e, --event=<value>...  Event name
  -k, --key=<value>...    (required) Entity keys to select for.
  -l, --limit=<value>     [default: 50] Limit the number of returned events to this value.
  -n, --entity=<value>    (required) Entity name
  -t, --token=<value>     [default: NOT-SET] Access token for your ledger.
  -x, --extended          show extra columns
  --columns=<value>       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=<value>        filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=<option>       output in a more machine friendly format
                          <options: csv|json|yaml>
  --sort=<value>          property to sort by (prepend '-' for descending)

DESCRIPTION
  Replay an entities events.

EXAMPLES
  $ evently selector:replay   -n article   -e add-comment   -k author

  $ evently selector:replay   -n article   -e add-comment -e delete-comment   -k author, -k date   --limit 10

See code: dist/commands/selector/replay.ts

`evently selector:selector-command`

USAGE
  $ evently selector:selector-command [-t <value>]

FLAGS
  -t, --token=<value>  [default: NOT-SET] Access token for your ledger.

See code: dist/commands/selector/selector-command.ts

`evently selector:table`

USAGE
  $ evently selector:table [-t <value>]

FLAGS
  -t, --token=<value>  [default: NOT-SET] Access token for your ledger.

See code: dist/commands/selector/table.ts

evently-cloud / cli

readme