@aurora-ts/cli

aurora-ts-cli

• Usage
• Commands

Usage

$ npm install -g @aurora-ts/cli
$ aurora COMMAND
running command...
$ aurora (--version)
@aurora-ts/cli/1.7.13 darwin-arm64 node-v16.15.0
$ aurora --help [COMMAND]
USAGE
  $ aurora COMMAND
...

Commands

• aurora add
• aurora delete ELEMENTTYPE ELEMENTNAME
• aurora generate ELEMENTTYPE
• aurora hello PERSON
• aurora hello world
• aurora help [COMMAND]
• aurora keys
• aurora load ELEMENTTYPE
• aurora new NAME
• aurora pipeline
• aurora plugins
• aurora plugins:install PLUGIN...
• aurora plugins:inspect PLUGIN...
• aurora plugins:install PLUGIN...
• aurora plugins:link PLUGIN
• aurora plugins:uninstall PLUGIN...
• aurora plugins:uninstall PLUGIN...
• aurora plugins:uninstall PLUGIN...
• aurora plugins update
• aurora seed ELEMENTTYPE

aurora add

Generate pipeline to deploy application in cloud

USAGE
  $ aurora add [-h] [-f] [-d]

FLAGS
  -d, --dashboard
  -f, --force
  -h, --help       Show CLI help.

DESCRIPTION
  Generate pipeline to deploy application in cloud

EXAMPLES
  $ aurora add

  $ aurora --help

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

aurora delete ELEMENTTYPE ELEMENTNAME

Delete elements

USAGE
  $ aurora delete [ELEMENTTYPE] [ELEMENTNAME] [-h]

ARGUMENTS
  ELEMENTTYPE  (bounded-context|b|module|m) Type element to delete
  ELEMENTNAME  Name element to create

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Delete elements

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

aurora generate ELEMENTTYPE

Generate aurora bounded context/module [boundedContext, module]

USAGE
  $ aurora generate [ELEMENTTYPE] [-h] [-v] [-f] [-m <value>] [-g]

ARGUMENTS
  ELEMENTTYPE  (bounded-context|b|module|m|api|a) Type element to create

FLAGS
  -f, --force
  -g, --noGraphQLTypes
  -h, --help            Show CLI help.
  -m, --module=<value>
  -v, --verbose

DESCRIPTION
  Generate aurora bounded context/module [boundedContext, module]

EXAMPLES
  $ aurora generate module -m=my-bounded-context/my-module --force --noGraphQLTypes

  $ aurora --help

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

aurora hello PERSON

Say hello

USAGE
  $ aurora hello [PERSON] -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (required) Whom is saying hello

DESCRIPTION
  Say hello

EXAMPLES
  $ oex hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)

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

aurora hello world

Say hello world

USAGE
  $ aurora hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ oex hello world
  hello world! (./src/commands/hello/world.ts)

aurora help [COMMAND]

Display help for aurora.

USAGE
  $ aurora help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

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

DESCRIPTION
  Display help for aurora.

See code: @oclif/plugin-help

aurora keys

Generate private key and public key

USAGE
  $ aurora keys [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Generate private key and public key

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

aurora load ELEMENTTYPE

Reload aurora [bounded-context, module] from yaml file, located in the cliter folder

USAGE
  $ aurora load [ELEMENTTYPE] [-b <value>] [-d] [-f] [-h] [-m <value>] [-g] [-w] [-t] [-v]

ARGUMENTS
  ELEMENTTYPE  (bounded-context|b|module|m) Type element to create

FLAGS
  -b, --boundedContext=<value>
  -d, --dashboard
  -f, --force
  -g, --noGraphQLTypes
  -h, --help                    Show CLI help.
  -m, --module=<value>
  -t, --tests
  -v, --verbose
  -w, --overwriteInterface

DESCRIPTION
  Reload aurora [bounded-context, module] from yaml file, located in the cliter folder

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

aurora new NAME

Create new aurora project

USAGE
  $ aurora new [NAME] [-d] [-h] [-p] [-v]

ARGUMENTS
  NAME  Type name of element to create, application, package or dashboard.

FLAGS
  -d, --dashboard
  -h, --help       Show CLI help.
  -p, --package
  -v, --verbose

DESCRIPTION
  Create new aurora project

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

aurora pipeline

Generate pipeline to deploy application in cloud

USAGE
  $ aurora pipeline [-h] [-f] [-d]

FLAGS
  -d, --dashboard
  -f, --force
  -h, --help       Show CLI help.

DESCRIPTION
  Generate pipeline to deploy application in cloud

EXAMPLES
  $ aurora pipeline

  $ aurora --help

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

aurora plugins

List installed plugins.

USAGE
  $ aurora plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ aurora plugins

See code: @oclif/plugin-plugins

aurora plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ aurora plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ aurora plugins add

EXAMPLES
  $ aurora plugins:install myplugin 

  $ aurora plugins:install https://github.com/someuser/someplugin

  $ aurora plugins:install someuser/someplugin

aurora plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ aurora plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ aurora plugins:inspect myplugin

aurora plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ aurora plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ aurora plugins add

EXAMPLES
  $ aurora plugins:install myplugin 

  $ aurora plugins:install https://github.com/someuser/someplugin

  $ aurora plugins:install someuser/someplugin

aurora plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ aurora plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.

  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLES
  $ aurora plugins:link myplugin

aurora plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ aurora plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ aurora plugins unlink
  $ aurora plugins remove

aurora plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ aurora plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ aurora plugins unlink
  $ aurora plugins remove

aurora plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ aurora plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ aurora plugins unlink
  $ aurora plugins remove

aurora plugins update

Update installed plugins.

USAGE
  $ aurora plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

aurora seed ELEMENTTYPE

Seed database with bounded context or module selected

USAGE
  $ aurora seed [ELEMENTTYPE] [-h] [-m <value>] [-b <value>] [-l]

ARGUMENTS
  ELEMENTTYPE  (bounded-context|b|module|m) Type element to create

FLAGS
  -b, --boundedContext=<value>
  -h, --help                    Show CLI help.
  -l, --log
  -m, --module=<value>

DESCRIPTION
  Seed database with bounded context or module selected

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