cli.rst

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
• project
• job
• rm
• update-cache

Sharing and archiving a project:

• view
• export
• import
• move
• clone
• sync
• index

clone

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

config

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

diff

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

document

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

export

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

find

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

import

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

index

.. command-output:: signac index --help

init

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

job

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

move

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

project

.. command-output:: signac project --help

rm

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

schema

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

shell

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

statepoint

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

sync

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

update-cache

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

view

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