.. _flow-cli:

Command Line Interface
======================

Many core **signac-flow** functions are --- in addition to the Python interface --- accessible directly via the ``$ flow`` command line interface (CLI).

CLI Overview
------------

The available commands in the CLI can be shown by executing ``$ flow --help``:

.. command-output:: flow --help

List of commands:
    * `init`_
    * `template`_
    * `template create`_
    * `test-workflow`_

.. _flow-cli-init:

init
----

.. command-output:: flow init --help

.. _flow-cli-template:

template
--------

.. command-output:: flow template --help

.. _flow-cli-template-create:

template create
---------------

.. command-output:: flow template create --help

.. _flow-cli-test-workflow:

test-workflow
-------------

.. command-output:: flow test-workflow --help