xonsh
=====

.. raw:: html

    <p align="center">
    <b>xonsh</b> is a Python-powered, cross-platform, Unix-gazing shell language and command prompt.
    </p>

    <p align="center">
    The language is a superset of Python 3.5+ with additional shell primitives. <br>
    xonsh (pronounced <i>conch</i>) is meant for the daily use of experts and novices alike.
    </p>

    <p align="center">
    <a href="https://xon.sh/contents.html#installation"><img src="https://raw.githubusercontent.com/xonsh/xonsh/master/docs/_static/xonsh4.png" alt="What is xonsh?"></a>
    </p>

    <p align="center">
    If you like xonsh, :star: the repo and stay tuned by watching releases.
    </p>

    <p align="center">
    <img src="https://badges.gitter.im/xonsh/xonsh.svg" alt="Join the chat at https://gitter.im/xonsh/xonsh" target="https://gitter.im/xonsh/xonsh?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">
    <img src="https://img.shields.io/badge/%23xonsh%3Afeneas.org-Matrix-green" alt="Matrix room: #xonsh:feneas.org" target="https://matrix.to/#/#xonsh:feneas.org">
    <img src="https://travis-ci.org/xonsh/xonsh.svg?branch=master" alt="Travis" target="https://travis-ci.org/xonsh/xonsh">
    <img src="https://ci.appveyor.com/api/projects/status/github/xonsh/xonsh?svg=true" alt="Appveyor" target="https://ci.appveyor.com/project/xonsh/xonsh">
    <img src="https://circleci.com/gh/xonsh/xonsh.svg?style=shield" alt="circleci" target="https://circleci.com/gh/xonsh/xonsh">
    <img src="https://codecov.io/gh/xonsh/xonsh/branch/master/graph/badge.svg" alt="codecov" target="https://codecov.io/gh/xonsh/xonsh">
    </p>

First steps
***********

Visit https://xon.sh for more information:

- `Installation <https://xon.sh/contents.html#installation>`_ - using packages, docker or AppImage.
- `Tutorial <https://xon.sh/tutorial.html>`_ - step by step introduction in xonsh.
- `Xontribs <https://xon.sh/xontribs.html>`_ - list of awesome xonsh extensions.

Projects that use xonsh
***********************

- `gitsome <https://github.com/donnemartin/gitsome>`_: A supercharged Git/shell autocompleter with GitHub integration.
- `rever <https://regro.github.io/rever-docs/>`_: Cross-platform software release tool.
- `Regro autotick bot <https://github.com/regro/cf-scripts>`_: Regro Conda-Forge autoticker.
- `xxh <https://github.com/xxh/xxh>`_: Using xonsh wherever you go through the ssh.