.. This file is part of Sympathy for Data.
.. Copyright (c) 2020 Combine Control Systems AB
..
.. SYMPATHY FOR DATA COMMERCIAL LICENSE
.. You should have received a link to the License with Sympathy for Data.

.. _appendix_cli:

All command line options
------------------------


Top-level
^^^^^^^^^

``python -m sympathy --help``

.. code-block:: bash

    usage: sympathy [-h] [--version] {gui,cli,viewer,doc,install,uninstall,clear,resave,launch} ...

    Sympathy for Data

    options:
    -h, --help            show this help message and exit
    --version             show Sympathy for Data version and exit

    Commands:
    {gui,cli,viewer,doc,install,uninstall,clear,resave,launch}
                            Command
        gui                 run Sympathy in GUI mode
        cli                 run Sympathy in CLI mode
        viewer              open the viewer for specified data file
        doc                 generate documentation files
        install             install Sympathy (start menu, file associations)
        uninstall           uninstall Sympathy (start menu, file associations)
        clear               cleanup temporary files
        resave              read and resave specified flows
        launch              (internal use only)


Gui and Cli
^^^^^^^^^^^

The options for the gui and cli commands are similar.

``python -m sympathy gui --help``

.. code-block:: bash

    usage: sympathy gui [-h] [--exit-after-exception {0,1}] [-L LEVEL | --logger LOGGER LEVEL | --logging-config-file CONFIG-FILE] [--num-worker-processes NUM_WORKER_PROCESSES] [-I INIFILE] [--environment-credentials PREFIX] [--nocapture] [FILENAME]

    positional arguments:
    FILENAME              file containing workflow.

    options:
    -h, --help            show this help message and exit
    --exit-after-exception {0,1}
                            exit after uncaught exception occurs in a signal handler
    -L LEVEL, --loglevel LEVEL
                            the sympathy logger configuration level (e.g. -L warning).
    --logger LOGGER LEVEL
                            a logger configuration with a logger name and a level (e.g. --logger app.stats warning). This argument can be repeated.
    --logging-config-file CONFIG-FILE
                            logging config json-file with logging configuration in dictionary format for use with logging.config.dictConfig
    --num-worker-processes NUM_WORKER_PROCESSES
                            number of python worker processes (0) use system number of CPUs
    -I INIFILE, --inifile INIFILE
                            settings ini-file to use instead of the default
    --environment-credentials PREFIX
                            read credential secrets from environment variables starting with PREFIX that are encoded as json lists, e.g, PREFIX["secret","foo"]={"secret":"bar"}.
    --nocapture           disable capturing of node output and send it directly to stdout/stderr.


Viewer
^^^^^^

``python -m sympathy viewer --help``

.. code-block:: bash

    usage: sympathy viewer [-h] [FILENAME]

    positional arguments:
      FILENAME    path to Sympathy data file (*.sydata file)

    options:
      -h, --help  show this help message and exit



Doc
^^^

``python -m sympathy doc --help``

.. code-block:: bash

    usage: sympathy doc [-h] [--library-dir LIBRARY_DIR] [--output-dir OUTPUT_DIR] [--exclude-code-links] [-v]

    options:
      -h, --help            show this help message and exit
      --library-dir LIBRARY_DIR
                            path to library to generate docs for, if not specified generated documentation will be for the standard library and platform
      --output-dir OUTPUT_DIR
                            choose folder in which to output generated docs, if not specified generated documentation will be put next to the chosen library
      --exclude-code-links  disable generations of links to code
      -v, --verbose         verbose output



.. _appendix_cli_install:

Install
^^^^^^^

``python -m sympathy install --help``

.. code-block:: bash

    usage: sympathy install [-h] [--generate-all] [--compile] [--compile-all] [--register] [--set-preference OPT-NAME OPT-VALUE] [--locate ITEM] [--all]

    options:
      -h, --help            show this help message and exit
      --generate-all        generate parser files
      --compile             compile sympathy
      --compile-all         compile all site-package files
      --register            register desktop application and create shortcuts
      --set-preference OPT-NAME OPT-VALUE
                            set value of setting
      --locate ITEM         locate item (e.g, --locate inifile)
      --all                 perform full installation, includes all options, except --set-preference and --locate. This is the default if no other options are provided.


Uninstall
^^^^^^^^^

``python -m sympathy uninstall --help``

.. code-block:: bash

    usage: sympathy uninstall [-h]

    options:
      -h, --help  show this help message and exit


Clear
^^^^^

``python -m sympathy clear --help``

.. code-block:: bash

    usage: sympathy clear [-h] [--caches] [--sessions] [--docs]

    options:
      -h, --help  show this help message and exit
      --caches    clear caches for Sympathy.
      --sessions  clear sessions for Sympathy.
      --docs      clear documentation for Sympathy


Resave
^^^^^^

``python -m sympathy resave --help``

.. code-block:: bash

    usage: sympathy resave [-h] FILENAME [FILENAME ...]

    positional arguments:
      FILENAME    path(s) to Sympathy flow(s) (*.syx files)

    options:
      -h, --help  show this help message and exit