<commit_before>=====
Usage
=====

The scikit-ci command line executable allows to execute commands associated
with steps described in a ``scikit-ci.yml`` configuration file.



Calling scikit-ci through ``python -m ci``
------------------------------------------

You can invoke scikit-ci through the Python interpreter from the command line::

    python -m ci [...]

This is equivalent to invoking the command line script ``ci [...]``
directly.


Getting help on version, option names
-------------------------------------

::

    ci --version   # shows where ci was imported from
    ci -h | --help # show help on command line<commit_msg>docs: Update usage to describe how to invoke all or some of the steps<commit_after>=====
Usage
=====

The scikit-ci command line executable allows to execute commands associated
with steps described in a scikit-ci
:doc:`configuration file </scikit-ci-yml>`.



Executing scikit-ci steps
---------------------------------

By default, invoking scikit-ci will execute all steps listed in
scikit-ci :doc:`configuration file </scikit-ci-yml>`::

    ci

You can also specify one or multiple steps::

    ci before_install install


Calling scikit-ci through ``python -m ci``
------------------------------------------

You can invoke scikit-ci through the Python interpreter from the command line::

    python -m ci [...]

This is equivalent to invoking the command line script ``ci [...]``
directly.


Getting help on version, option names
-------------------------------------

::

    ci --version   # shows where ci was imported from
    ci -h | --help # show help on command line
{'fraction_non_alphanumeric': 0.20147874306839186, 'fraction_numerical': 0.0, 'mean_word_length': 2.171875, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, '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': '5236179', 'n_tokens_mistral': 427, 'n_tokens_neox': 396, 'n_words': 190}