CLI Reference

This page serves as a reference for the Kitto command line interface.

Table of Contents

• mix kitto.new
• mix kitto.server
• mix kitto.install
• Generators
  • mix kitto.gen.dashboard
  • mix kitto.gen.job
  • mix kitto.gen.widget

mix kitto.new

Kitto installer. Generates a scaffolding to build a new dashboard upon.

See: https://github.com/kittoframework/demo

To install the installer archive, see: https://github.com/kittoframework/kitto#installation

mix kitto.server

Starts the application

Command line options:

This task accepts the same command-line arguments as run. For additional information, refer to the documentation for Mix.Tasks.Run.

The --no-halt flag is automatically added.

mix kitto.install

Installs community Widget/Job from a Github Gist

mix kitto.install --widget test_widget --gist JanStevens/0209a4a80cee782e5cdbe11a1e9bc393
mix kitto.install --gist 0209a4a80cee782e5cdbe11a1e9bc393

Options

• --widget: Specifies the widget name that will be used as directory name in the widgets directory. By default we use the js filename as directory
• --gist: The gist to download from, specified as Username/Gist or Gist

Generators

mix kitto.gen.dashboard

Generates a new empty dashboard template

Usage:

$ mix kitto.gen.dashboard all_the_data
# generates `dashboards/all_the_data.html.eex`

mix kitto.gen.job

Generates a new empty job

Usage:

$ mix kitto.gen.job some_job
# generates `jobs/some_job.exs`

mix kitto.gen.widget

Generates a new widget

Usage:

$ mix kitto.gen.widget this_widget
# generates `widgets/this_widget/this_widget.js` and
# `widgets/this_widget/this_widget.scss`