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


``sh-session
$ 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-configget-key)
* [eta config:set [KEY] [VALUE]](#eta-configset-key-value)
* eta db:reset
* eta db:seed
* eta extract-config
* [eta foreach [COMMAND]](#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-help-command)
* [eta init [TARGET]](#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_