untool

untool

untool is our main command line interface. It serves a single purposes: it can be used to to control untool projects. To do so, it provides the terminal command un. Additionally, untool provides a bare-bones logging facility that can be disabled by providing a -q (or --quiet) CLI argument.

Installation

untool is meant to be installed globally or inside specific projects. If you install it globally, you can directly call it inside any untool powered project.

$ yarn global add untool # OR npm install --global untool

If you want to add a local command line interface to your project to be used in package.json scripts, simply add it to that project.

$ yarn add untool # OR npm install untool

Utilization

untools's mode of operation is that it will find a locally installed @untool/yargs and control it, acting as a very minimal wrapper around it.

$ un start -s
[foo] started in development mode
[foo] listening at http://localhost:8080
[foo] built successfully in 1.4s

You can also call it without arguments to see a list of available commands. This list will vary depending on the mixins you installed in every individual project.

$ un
Usage: un <command> [options]

Commands:
  un serve    Serve foo
  un start    Build and serve foo
  un build    Build foo
  un develop  Serve foo in watch mode

Options:
  --quiet, -q  Suppress log output                                    [boolean]
  --help, -h   Show help                                              [boolean]