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:

$ flow --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-flow/envs/v0.26.0/bin/flow", line 5, in <module>
    from flow.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-flow/envs/v0.26.0/lib/python3.11/site-packages/flow/__main__.py", line 22, in <module>
    from .scripts.template_test import test_workflow_parser
ModuleNotFoundError: No module named 'flow.scripts'

List of commands:

init
template
template create
test-workflow

init¶

$ flow init --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-flow/envs/v0.26.0/bin/flow", line 5, in <module>
    from flow.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-flow/envs/v0.26.0/lib/python3.11/site-packages/flow/__main__.py", line 22, in <module>
    from .scripts.template_test import test_workflow_parser
ModuleNotFoundError: No module named 'flow.scripts'

template¶

$ flow template --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-flow/envs/v0.26.0/bin/flow", line 5, in <module>
    from flow.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-flow/envs/v0.26.0/lib/python3.11/site-packages/flow/__main__.py", line 22, in <module>
    from .scripts.template_test import test_workflow_parser
ModuleNotFoundError: No module named 'flow.scripts'

template create¶

$ flow template create --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-flow/envs/v0.26.0/bin/flow", line 5, in <module>
    from flow.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-flow/envs/v0.26.0/lib/python3.11/site-packages/flow/__main__.py", line 22, in <module>
    from .scripts.template_test import test_workflow_parser
ModuleNotFoundError: No module named 'flow.scripts'

test-workflow¶

$ flow test-workflow --help
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-flow/envs/v0.26.0/bin/flow", line 5, in <module>
    from flow.__main__ import main
  File "/home/docs/checkouts/readthedocs.org/user_builds/signac-flow/envs/v0.26.0/lib/python3.11/site-packages/flow/__main__.py", line 22, in <module>
    from .scripts.template_test import test_workflow_parser
ModuleNotFoundError: No module named 'flow.scripts'