.. include:: ./../macros.txt

.. _FOX_CLI_USAGE:

|fox-cli| Usage
===============

Every command, subcommand, their subcommands etc. support ``-h``/``--help`` to
learn more about the possibilities to interact with the repository.

.. include:: ./../../build/docs/fox_help.txt

Subcommands
-----------

.. toctree::
   :maxdepth: 1
   :caption: fox.py usage documentation

   ./fox/bootloader/fox_bootloader.rst
   ./fox/build/fox_waf.rst
   ./fox/bms/fox_bms.rst
   ./fox/cli_unittest/fox_cli-unittest.rst
   ./fox/com/fox_com.rst
   ./fox/db/fox_db.rst
   ./fox/embedded_ut/fox_ceedling.rst
   ./fox/etl/fox_etl.rst
   ./fox/gui/fox_gui.rst
   ./fox/ide/fox_ide.rst
   ./fox/install/fox_install.rst
   ./fox/log/fox_log.rst
   ./fox/vtp/vtp.rst
   ./fox/misc/fox_misc.rst
   ./fox/plot/fox_plot.rst
   ./fox/pre_commit/fox_pre-commit.rst
   ./fox/release/fox_release.rst
   ./fox/run_program/fox_run-program.rst
   ./fox/run_script/fox_run-script.rst

.. _fox_cli_package:

|fox-cli-package|
-----------------

.. attention::

   Ensure that the |virtual-python-environment|, which contains the
   |fox-cli-package|, is :ref:`activated<INSTALL_VENV>` before using it.

.. note::

   The ``fox_cli`` directory within the user's Documents directory will contain
   any data generated by the |fox-cli-package|.

The |fox-cli-package| is a condensed version of the |fox-cli|.
Instead of using the shell wrappers, which only work within the repository,
the ``fox-cli`` command is provided to interact with the package.
This command is only accessible outside of the repository.

.. tabs::

   .. group-tab:: Win32

      .. code-block:: shell

         fox-cli

   .. group-tab:: Linux

      .. code-block:: shell

         fox-cli

The following subcommands are available in the |fox-cli-package|:

.. include:: ./../../build/docs/fox_cli_package_help.txt