Project Eta CLI

The CLI for managing and developing with Eta. All commands should be run from the root directory of an Eta instance.

• Project Eta CLI

$ npm install -g @xroadsed/eta-cli
$ eta COMMAND
running command...
$ eta (-v|--version|version)
@xroadsed/eta-cli/1.3.25 darwin-x64 node-v10.6.0
$ eta --help [COMMAND]
USAGE
  $ eta COMMAND
...

• eta clean
• eta compile:client
• eta compile:server
• eta config:get [KEY]
• eta config:set [KEY] [VALUE]
• eta db:reset
• eta db:seed
• eta extract-config
• eta foreach [COMMAND]
• eta generate:clientjs MODULE
• eta generate:controller MODULENAME ROUTE
• eta generate:indexes
• eta generate:model MODULENAME MODELNAME
• eta generate:module MODULE
• eta help [COMMAND]
• eta init [TARGET]
• eta install URL
• eta lint:client
• eta lint:server
• eta pull
• eta setup
• eta start
• eta test:core
• eta test:modules

eta clean

clean all JS files without matching TS files

USAGE
  $ eta clean

See code: lib/commands/clean.js

eta compile:client

compile client-side Typescript

USAGE
  $ eta compile:client

OPTIONS
  -m, --modules=modules  modules to compile client-side JS for (comma-separated)
  --no-exit              Don't exit with an error code if compilation fails

See code: lib/commands/compile/client.js

eta compile:server

compile server-side Typescript

USAGE
  $ eta compile:server

OPTIONS
  --no-exit  Don't exit with an error code if compilation fails

ALIASES
  $ eta compile

See code: lib/commands/compile/server.js

eta config:get [KEY]

log a config variable's value

USAGE
  $ eta config:get [KEY]

ARGUMENTS
  KEY  The key to get (including domain)

See code: lib/commands/config/get.js

eta config:set [KEY] [VALUE]

set a config variable

USAGE
  $ eta config:set [KEY] [VALUE]

ARGUMENTS
  KEY    The key to set (including domain)
  VALUE  The value to set

See code: lib/commands/config/set.js

eta db:reset

reset the database (using global connection info)

USAGE
  $ eta db:reset

OPTIONS
  -n, --no-wait  Don't wait 3 seconds before resetting

See code: lib/commands/db/reset.js

eta db:seed

seed the database (using global connection info)

USAGE
  $ eta db:seed

OPTIONS
  -n, --no-log  Don't log anything from the Eta instance

See code: lib/commands/db/seed.js

eta extract-config

create a config file for 'eta init' based on the current eta setup

USAGE
  $ eta extract-config

See code: lib/commands/extract-config.js

eta foreach [COMMAND]

run a command in each module directory

USAGE
  $ eta foreach [COMMAND]

ARGUMENTS
  COMMAND  The command to run in each directory

OPTIONS
  -c, --clientJS=clientJS  run in client-side JS directories only

See code: lib/commands/foreach.js

eta generate:clientjs MODULE

generate new client-side JS setup

USAGE
  $ eta generate:clientjs MODULE

ARGUMENTS
  MODULE  module name to generate client-side JS for

See code: lib/commands/generate/clientjs.js

eta generate:controller MODULENAME ROUTE

generate new controller

USAGE
  $ eta generate:controller MODULENAME ROUTE

ARGUMENTS
  MODULENAME  module name to generate controller in
  ROUTE       route to generate controller for

See code: lib/commands/generate/controller.js

eta generate:indexes

generate index files

USAGE
  $ eta generate:indexes

ALIASES
  $ eta generate

See code: lib/commands/generate/indexes.js

eta generate:model MODULENAME MODELNAME

generate new TypeORM model

USAGE
  $ eta generate:model MODULENAME MODELNAME

ARGUMENTS
  MODULENAME  module name to generate controller in
  MODELNAME   name for new model

See code: lib/commands/generate/model.js

eta generate:module MODULE

generate new Eta module

USAGE
  $ eta generate:module MODULE

ARGUMENTS
  MODULE  module name to generate

See code: lib/commands/generate/module.js

eta help [COMMAND]

display help for eta

USAGE
  $ eta help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

eta init [TARGET]

init an Eta eta project

USAGE
  $ eta init [TARGET]

ARGUMENTS
  TARGET  target directory; if not provided will use the 'name' property in the config file

OPTIONS
  --config=config  (required) config file
  --host=host      add config folder for this host (e.g. localhost)

See code: lib/commands/init.js

eta install URL

install an Eta module

USAGE
  $ eta install URL

ARGUMENTS
  URL  url to install module from

See code: lib/commands/install.js

eta lint:client

lint client-side Typescript for style errors

USAGE
  $ eta lint:client

OPTIONS
  -f, --fix              Passes --fix to tslint (attempt to automatically fix problems)
  -m, --modules=modules  Only lint these modules (comma-separated)

See code: lib/commands/lint/client.js

eta lint:server

lint server-side Typescript for style errors

USAGE
  $ eta lint:server

OPTIONS
  -f, --fix  Pass --fix to tslint (attempt to automatically fix problems)

ALIASES
  $ eta lint

See code: lib/commands/lint/server.js

eta pull

pull all (or some) Eta modules from remote

USAGE
  $ eta pull

OPTIONS
  -m, --modules=modules  Module names to pull

See code: lib/commands/pull.js

eta setup

set up a fresh Eta instance

USAGE
  $ eta setup

See code: lib/commands/setup.js

eta start

generate indexes, compile and start the server

USAGE
  $ eta start

OPTIONS
  -f, --fast  don't generate or compile, just start

See code: lib/commands/start.js

eta test:core

run Eta's unit tests

USAGE
  $ eta test:core

OPTIONS
  --reporter=reporter  reporter name for mocha to use

ALIASES
  $ eta test

See code: lib/commands/test/core.js

eta test:modules

run all module unit/integration tests

USAGE
  $ eta test:modules

OPTIONS
  -f, --fast             don't start the server, just run tests
  -l, --log-all          log everything from server
  -m, --modules=modules  only test these modules (comma-separated)
  -r, --reset            reset / seed the database before running tests
  -s, --slow=slow        [default: 1500] max time until Mocha flags a test as slow (ms)
  -t, --timeout=timeout  [default: 5000] max time until Mocha kills a test (ms)
  --reporter=reporter    reporter name for mocha to use

See code: lib/commands/test/modules.js