========
Cyclopts
========

.. include:: ../../README.md
   :parser: myst_parser.sphinx_


For extensive documentation on all the features Cyclopts has to offer, checkout the :ref:`API` page.

.. toctree::
   :maxdepth: 1
   :caption: Usage

   Installation.rst
   getting_started.rst
   commands.rst
   parameters.rst
   default_parameter.rst
   groups.rst
   parameter_validators.rst
   group_validators.rst
   help.rst
   version.rst
   shell_completion.rst
   rules.rst
   text_editor.rst
   api
   cli_reference.rst
   known_issues.rst


.. toctree::
   :maxdepth: 2
   :caption: Advanced Usage

   lazy_loading.rst
   help_customization.rst
   user_classes.rst
   args_and_kwargs.rst
   config_file.rst
   sphinx_integration.rst
   mkdocs_integration.rst
   packaging.rst
   app_calling.rst
   meta_app.rst
   command_chaining.rst
   autoregistry

.. toctree::
   :maxdepth: 2
   :caption: Cookbook

   cookbook/app_upgrade.rst
   cookbook/dataclass_commands.rst
   cookbook/interactive_help.rst
   cookbook/rich_formatted_exceptions.rst
   cookbook/sharing_parameters.rst
   cookbook/unit_testing.rst
   cookbook/file_or_stdin_stdout.rst
   cookbook/random_tips.rst

.. toctree::
   :maxdepth: 2
   :caption: Migration

   migration/typer.rst

.. toctree::
   :maxdepth: 2
   :caption: Alternative Libraries

   vs_typer/README.rst
   vs_fire/README.rst
   vs_arguably/README.rst
