occurrence-cli

Occurrence Admin CLI

• Usage
• Commands

Usage

$ npm install -g @absa-subatomic/occurrence-cli
$ occurrence COMMAND
running command...
$ occurrence (-v|--version|version)
@absa-subatomic/occurrence-cli/0.0.6 linux-x64 node-v12.14.1
$ occurrence --help [COMMAND]
USAGE
  $ occurrence COMMAND
...

Commands

• occurrence create-api-user USERNAME
• occurrence create-domain DOMAINNAME
• occurrence create-schema DOMAINNAME
• occurrence grant-user-domain-roles USERNAME DOMAIN ROLES
• occurrence help [COMMAND]
• occurrence login
• occurrence update-domain-schema OCCURRENCECONFIGDIRECTORY

occurrence create-api-user USERNAME

Create an api user

USAGE
  $ occurrence create-api-user USERNAME

OPTIONS
  -h, --help                           show CLI help
  -r, --role=(admin|system_read|user)  [default: user] The SystemRole the user should have

EXAMPLE
  $ occurrence create-api-user username
  Api User created

occurrence create-domain DOMAINNAME

Create a domain

USAGE
  $ occurrence create-domain DOMAINNAME

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ occurrence create-domain myDomain
  Domain created

occurrence create-schema DOMAINNAME

Create a schema in a domain

USAGE
  $ occurrence create-schema DOMAINNAME

OPTIONS
  -f, --file=file  (required) File containing the GQL schema definition
  -h, --help       show CLI help

EXAMPLE
  $ occurrence create-schema myDomain -f=schema.graphql
  Schema created

occurrence grant-user-domain-roles USERNAME DOMAIN ROLES

Grant an api user domain roles

USAGE
  $ occurrence grant-user-domain-roles USERNAME DOMAIN ROLES

ARGUMENTS
  USERNAME
  DOMAIN
  ROLES     (publisher|consumer|domain_admin|schema_viewer) The list of roles to grant to the user

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ occurrence grant-user-domain-roles username domain role1 role2
       Roles granted

occurrence help [COMMAND]

display help for occurrence

USAGE
  $ occurrence help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

occurrence login

set the occurrence session

USAGE
  $ occurrence login

OPTIONS
  -h, --help         show CLI help
  -t, --token=token  (required)
  -u, --host=host    (required) occurrence gateway host url

EXAMPLE
  $ occurrence login -u=http://localhost:4000/ -t=token
  Session set to http://localhost:4000/

occurrence update-domain-schema OCCURRENCECONFIGDIRECTORY

Maintain all schema definitions for a Domain using an Occurrence configuration directory

USAGE
  $ occurrence update-domain-schema OCCURRENCECONFIGDIRECTORY

OPTIONS
  -h, --help  show CLI help

EXAMPLE
  $ occurrence update-domain-schema occurrenceConfigDirectory