CLI
====

Command: blackgate
------------------

    $ blackgate [blackgate_options] <command> [command_options]

blackgate_options
-------------------

* `-c /path/to/blackgate.yml`

Blackgate configuration file.

Blackgate by default search configuration file from files listed below by order.

* `./blackgate.yml`
* `~/.blackgate.yml`
* `/usr/local/etc/blackgate/blackgate.yml`
* `/etc/blackgate/blackgate.yml`

Blackgate will fail to run without loading a yaml config file, except command `init`.
This file contains configuration for upstream services, plugins, etc.

* `--daemon/--no-daemon`

Set Blackgate running mode.

When set to `--daemon` (default), Blackgate will be executed as daemon.
When set to `--no-daemon`, Blackgate will be executed foreground. This is useful if you
want to use `supervisord` to manage process.

* `--pidfile`

Set Blackgate pidfile. Default `/var/run/blackgate.pid`.

It's only available when you are running Blackgate in daemon mode.

* `--stdin`

Set Blackgate input. Default `/dev/null`.

* `--stdout`

Set Blackgate output. Default `/dev/null`.

* `--stderr`

Set Blackgate error. Default `/dev/null`.

* `--directory`

Set process working directory. Default current directory.


command: start
---------------

Starts a Blackgate instance::

    $ blackgate start


command: stop
--------------

Terminates a Blackgate instance::

    $ blackgate stop

Note: Blackgate will shutdown instance gracefully.


command: restart
----------------

Restart a Blackgate instance::

    $ blackgate restart

Note: If Blackgate was not running before executing this command, it will start
a Blackgate instance directly.


command: status
---------------

Output the status of Blackgate::

    $ blackgate status