.. _signac-cli:

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

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

CLI Overview
============

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

.. command-output:: signac --help

The commands can be roughly grouped by task, ordered by frequency of use:

Using a project:
    * `statepoint`_
    * `document`_
    * `find`_
    * `shell`_
    * `schema`_
    * `diff`_

Modifying a project:
    * `init`_
    * `config`_
    * `job`_
    * `rm`_
    * `update-cache`_

Sharing and archiving a project:
    * `view`_
    * `export`_
    * `import`_
    * `move`_
    * `clone`_
    * `sync`_

.. _signac-cli-clone:

clone
=====

.. command-output:: signac clone --help


.. _signac-cli-config:

config
======

.. command-output:: signac config --help


.. _signac-cli-diff:

diff
====

.. command-output:: signac diff --help


.. _signac-cli-document:

document
========

.. command-output:: signac document --help


.. _signac-cli-export:

export
======

.. command-output:: signac export --help


.. _signac-cli-find:

find
====

.. command-output:: signac find --help


.. _signac-cli-import:

import
======

.. command-output:: signac import --help


.. _signac-cli-init:

init
====

.. command-output:: signac init --help


.. _signac-cli-job:

job
===

.. command-output:: signac job --help


.. _signac-cli-move:

move
====

.. command-output:: signac move --help


.. _signac-cli-rm:

rm
==

.. command-output:: signac rm --help


.. _signac-cli-schema:

schema
======

.. command-output:: signac schema --help


.. _signac-cli-shell:

shell
=====

.. command-output:: signac shell --help


.. _signac-cli-statepoint:

statepoint
==========

.. command-output:: signac statepoint --help


.. _signac-cli-sync:

sync
====

.. command-output:: signac sync --help


.. _signac-cli-update-cache:

update-cache
============

.. command-output:: signac update-cache --help


.. _signac-cli-view:

view
====

.. command-output:: signac view --help