<commit_before>Command Line Interface
======================

Many lymph commands produce unicode output. Therefore, you'll have to set your
locale (LC_ALL or LC_CTYPE) to UTF-8.

If you want to pipe lymph commands with python2, you might have to set 
PYTHONIOENCODING to UTF-8 as well.

.. program:: lymph

The following options apply to all subcommands:

.. cmdoption:: --ip <address>

.. cmdoption:: -p <port>, --port <port>

.. cmdoption:: -g, --guess-external-ip

.. cmdoption:: -c <file>, --config <file>

    Read the configuration from <file>. This can also be specified as an environment
    variable :envvar:`LYMPH_CONFIG`. The default value is ``.lymph.yml``.

.. cmdoption:: --loglevel <level>

.. cmdoption:: --logfile <file>


.. _cli-lymph-discover:

.. program:: lymph discover

``lymph discover``
~~~~~~~~~~~~~~~~~~


.. _cli-lymph-inspect:

.. program:: lymph inspect

``lymph inspect``
~~~~~~~~~~~~~~~~~



.. _cli-lymph-instance:

.. program:: lymph instance

``lymph instance``
~~~~~~~~~~~~~~~~~~

.. cmdoption:: -i, --isolated

    Isolated instances don't register with the service registry.


.. _cli-lymph-node:

.. program:: lymph node

``lymph node``
~~~~~~~~~~~~~~


.. _cli-lymph-request:

.. program:: lymph request

``lymph request``
~~~~~~~~~~~~~~~~~


.. _cli-lymph-shell:

``lymph shell``
~~~~~~~~~~~~~~~

Starts an interactive Python shell. The following objects will be available in the global namespace:

``client``
    a configured :class:`lymph.client.Client` instance
<commit_msg>Updated cli docs<commit_after>Command Line Interface
======================

Many lymph commands produce unicode output. Therefore, you'll have to set your
locale (LC_ALL or LC_CTYPE) to UTF-8.

If you want to pipe lymph commands with Python 2, you might have to set
PYTHONIOENCODING to UTF-8 as well.

.. program:: lymph

The following options apply to all subcommands:

.. cmdoption:: --config <file>, -c <file>

    Read the configuration from <file>. This can also be specified as an environment
    variable :envvar:`LYMPH_CONFIG`. The default value is ``.lymph.yml``.

.. cmdoption:: --loglevel <level>

.. cmdoption:: --logfile <file>

.. cmdoption:: --color

    Force output coloring

.. cmdoption:: --no-color

    Disable output coloring


.. _cli-lymph-discover:

.. program:: lymph discover

``lymph discover``
~~~~~~~~~~~~~~~~~~


.. _cli-lymph-inspect:

.. program:: lymph inspect

``lymph inspect``
~~~~~~~~~~~~~~~~~



.. _cli-lymph-instance:

.. program:: lymph instance

``lymph instance``
~~~~~~~~~~~~~~~~~~

.. cmdoption:: --ip <address>

.. cmdoption:: --port <port>, -p <port>

.. cmdoption:: --guess-external-ip, -g

.. cmdoption:: -i, --isolated

    Isolated instances don't register with the service registry.

.. cmdoption:: --reload

    Automatically stops the service when imported Python files in the current
    working directory change. The process will be restarted by the node.
    Do not use this in production.


.. _cli-lymph-node:

.. program:: lymph node

``lymph node``
~~~~~~~~~~~~~~

This command takes the same commandline options as ``lymph instance``.


.. _cli-lymph-request:

.. program:: lymph request

``lymph request``
~~~~~~~~~~~~~~~~~


.. _cli-lymph-shell:

``lymph shell``
~~~~~~~~~~~~~~~

Starts an interactive Python shell. The following objects will be available in the global namespace:

``client``
    a configured :class:`lymph.client.Client` instance

``config``
    a loaded :class:`lymph.config.Configuration` instance
{'fraction_non_alphanumeric': 0.1864116471595775, 'fraction_numerical': 0.0017128175849272054, 'mean_word_length': 3.653386454183267, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2070873', 'n_tokens_mistral': 1146, 'n_tokens_neox': 995, 'n_words': 368}