.. _command-line:

##################################################
Running ``xpipeline-workflow`` on the command line
##################################################

As described on the home page, the main interface to the xpipeline-workflow algorithm is the command-line executable ``xpipeline-workflow``.

Basic instructions
==================

Basic instructions on running ``xpipeline-workflow`` can be gained by looking at the ``--help`` menu:

.. command-output:: xpipeline-workflow --help

Detailed instructions
=====================

A few of the command-line options require special formatting, use the reference below for more detailed info.