#########################
The Xonsh Shell
#########################

.. include:: intro.rst

.. include:: comparison.rst

.. include:: installation.rst


Docs
====

Beginner
--------

The fundamentals of using Xonsh, including basic commands, syntax,
and how subprocesses work in practice. This section introduces key concepts
step by step and helps you build a solid foundation for working in the shell.

.. toctree::
    :titlesonly:
    :maxdepth: 1

    tutorial
    strings
    subprocess
    python
    error_handling
    Extensions on Github <https://github.com/topics/xontrib>
    Ask question <https://github.com/xonsh/xonsh/discussions>

Regular User
-------------

How to use Xonsh efficiently in daily workflows by configuring
environment variables, aliases, and history. It also covers customization
options, keyboard shortcuts, and practical tips to improve productivity
and streamline your command-line experience.

.. toctree::
    :titlesonly:
    :maxdepth: 1

    xonshrc
    envvars
    aliases
    history
    keyboard_shortcuts
    prompt
    events
    globbing
    macros
    xonsh_session
    launch
    platforms
    Open technical issue <https://github.com/xonsh/xonsh>

Creator
-------

How to extend Xonsh by building projects, creating extensions,
and customizing tab-completion. This section also explores deeper integrations,
event handling, and advanced customization techniques for building powerful
developer tools.

.. toctree::
    :titlesonly:
    :maxdepth: 1

    editors
    python_virtual_environments
    xonsh_projects
    callable_aliases
    events_tutorial
    env
    completers
    xontrib
    embedding
    debug
    api/index
    Create an extension <https://github.com/xonsh/xontrib-template>

Contributor
-----------

The internal architecture of Xonsh and how to work with its API.
It also guides you through contributing to the project, understanding the codebase,
and collaborating with others.

.. toctree::
    :titlesonly:
    :maxdepth: 1
    :hidden:

    developer
    lib/index
    history_backend

* `Developer’s Guide <developer.html>`_
* `Xonsh Library Reference <lib/index.html>`_
* `History Backend <history_backend.html>`_
* `Contribute to documentation <https://github.com/xonsh/xonsh/tree/main/docs>`_
* Write a note or an article about Xonsh.
* Send a link to Xonsh to your favorite blogger.
* Add Xonsh support in third party tool: `package manager <https://github.com/topics/package-manager>`_, `terminal emulator <https://github.com/topics/terminal-emulators>`_, `console tool <https://github.com/topics/console>`_, `IDE <https://github.com/topics/ide>`_.
* Give a star to `xonsh repository <https://github.com/xonsh/xonsh>`_ and to `xontribs <https://github.com/topics/xontrib>`_ you like.
* Solve a `popular issue <https://github.com/xonsh/xonsh/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc>`_ or `high priority issue <https://github.com/xonsh/xonsh/issues?q=is%3Aopen+is%3Aissue+label%3Apriority-high+sort%3Areactions-%2B1-desc>`_ or a `good first issue <https://github.com/xonsh/xonsh/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+sort%3Areactions-%2B1-desc>`_.
* Take an `idea <https://github.com/xonsh/xontrib-template/issues?q=is%3Aopen+is%3Aissue+label%3Aidea+sort%3Areactions-%2B1-desc>`_ and `create a new xontrib <https://github.com/xonsh/xontrib-template#why-use-this-template>`_.
* Contribute to `Xonsh Public API <https://github.com/xonsh/xonsh/tree/main/xonsh/api>`_.
* Test Xonsh with compiler, interpreter, optimizer and report upstream issues e.g. `Nuitka <https://github.com/xonsh/xonsh/issues/2895#issuecomment-3665753657>`_, `RustPython <https://github.com/xonsh/xonsh/issues/5082#issue-1611837062>`_.
* Use high quality LLMs with max effort and testing to dive into the core, suggest improvements, refactor and fix issues.
* Design more `logos and images <https://github.com/xonsh/logo>`_, `improve <https://github.com/xonsh/xonsh/blob/12f12ce94f1b6c92218e22fbdaaa846e16ac8b2d/docs/_templates/index.html#L9>`_ `xonsh website <https://xon.sh/>`_.
* `Become a sponsor to Xonsh <https://github.com/sponsors/xonsh>`_.


Links
=====

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
* `Xonsh Community <https://xonsh.zulipchat.com/join/hbvue5rimpdkwkdjuiqfs7tv/>`_
* `Xonsh Fediverse <https://mastodon.online/@xonsh>`_
* `Xonsh Matrix <https://matrix.to/#/#xonsh:matrix.org>`_
* `Xonsh Merch <https://www.hellotux.com/xonsh>`_
