.. _ui-cli:

UI-CLI
======

The UI-CLI is a simple command line tool inside a XMM project folder if the
UI package is correctly linked as described in :ref:`Getting started<intro>`.

The following commands are available:

xmm-ui dev
^^^^^^^^^^

Builds the development version of the UI with webpack and starts eslint in watch mode.

xmm-ui build
^^^^^^^^^^^^

Builds the optimized, minified production version of the UI.

xmm-ui serve
^^^^^^^^^^^^

Starts a node server that serves the production bundle.

**Arguments:**

- `host`: Optional, default is localhost.
- `port`: Optional, default is 3000.

Example::

      xmm-ui serve --host=localhost --port=3001

xmm-ui test
^^^^^^^^^^^

Runs all tests.

xmm-ui test-watch
^^^^^^^^^^^^^^^^^^^^^

Runs all tests and keeps jest in watch mode monitoring the files.

xmm-ui lint
^^^^^^^^^^^^^^^

Lints all javascript and reports the errors, CI builds with any warnings will fail.

xmm-ui lint-watch
^^^^^^^^^^^^^^^^^^^^^

Lints all javascript and reports the errors, keeps eslint running in watch mode.