🐚 Python-powered shell. Full-featured and cross-platform.
Find a file
Gil Forsyth 013fa760a0
refactor(amalgamate): remove amalgamation (#4858)
Co-authored-by: Noorhteen Raja NJ <jnoortheen@gmail.com>
2022-07-04 10:40:16 +05:30
.github refactor(amalgamate): remove amalgamation (#4858) 2022-07-04 10:40:16 +05:30
appimage Update pre-requirements.txt (#4073) 2021-01-30 15:13:33 -05:00
ci fix: xonfig web is not upto-date (#4606) 2022-01-18 11:11:16 -05:00
docs Pre commit ci (#4863) 2022-07-01 11:47:01 -04:00
news refactor(amalgamate): remove amalgamation (#4858) 2022-07-04 10:40:16 +05:30
scripts re-run CI tests 2020-08-08 14:02:44 -04:00
tests fix(pyghooks): Fix some errors caused by an unset Xonsh session env when using XonshLexer as a Pygments plugin. (#4860) 2022-06-30 10:40:58 -04:00
xompletions feat: add xontrib-django 2022-04-12 14:19:15 +05:30
xonsh refactor(amalgamate): remove amalgamation (#4858) 2022-07-04 10:40:16 +05:30
xontrib Pre commit ci (#4863) 2022-07-01 11:47:01 -04:00
.authors.yml Updated authorship for 0.12.6 2022-06-21 10:44:06 -04:00
.coveragerc refactor(amalgamate): remove amalgamation (#4858) 2022-07-04 10:40:16 +05:30
.gitattributes Remove syntax override for .xsh files (#4554) 2021-11-22 10:07:04 -05:00
.gitignore refactor(amalgamate): remove amalgamation (#4858) 2022-07-04 10:40:16 +05:30
.mailmap Updated authorship for 0.12.6 2022-06-21 10:44:06 -04:00
.pre-commit-config.yaml Pre commit ci (#4863) 2022-07-01 11:47:01 -04:00
AUTHORS.rst Updated authorship for 0.12.6 2022-06-21 10:44:06 -04:00
CHANGELOG.rst Updated CHANGELOG for 0.12.6 2022-06-21 10:44:07 -04:00
conftest.py use recommended pytest entry point in docs and comments (#4671) 2022-02-19 01:45:45 +05:30
CONTRIBUTING.rst refactor(amalgamate): remove amalgamation (#4858) 2022-07-04 10:40:16 +05:30
github_deploy_key.enc publish dev and latest release docs on xonsh-docs 2016-10-20 19:48:38 -04:00
license copyright update 2016-06-30 12:24:55 -04:00
logo.txt accomodate pip bug by making setup.py ascii 2015-11-16 15:12:02 -08:00
MANIFEST.in refactor(amalgamate): remove amalgamation (#4858) 2022-07-04 10:40:16 +05:30
pyproject.toml refactor(amalgamate): remove amalgamation (#4858) 2022-07-04 10:40:16 +05:30
README.rst docs: add "The xonsh shell community" to the readme (#4585) 2021-12-03 09:39:19 -05:00
rever.xsh Pre commit ci (#4863) 2022-07-01 11:47:01 -04:00
run-tests.xsh refactor(amalgamate): remove amalgamation (#4858) 2022-07-04 10:40:16 +05:30
setup.cfg refactor(amalgamate): remove amalgamation (#4858) 2022-07-04 10:40:16 +05:30
setup.py refactor(amalgamate): remove amalgamation (#4858) 2022-07-04 10:40:16 +05:30
xonsh-in-docker.py Update prompt-toolkit to 3.0.29 and remove xfail (#4818) 2022-05-25 09:16:34 +05:30

xonsh
=====

.. class:: center

    **xonsh** is a Python-powered, cross-platform, Unix-gazing shell language and command prompt.

    The language is a superset of Python 3.6+ with additional shell primitives.
    xonsh (pronounced *conch*) is meant for the daily use of experts and novices alike.

    .. image:: https://raw.githubusercontent.com/xonsh/xonsh/main/docs/_static/xonsh5.png
            :alt: What is xonsh?
            :align: center

.. class:: center

    If you like xonsh, :star: the repo, `write a tweet`_ and stay tuned by watching releases.

    .. image:: https://badges.gitter.im/xonsh/xonsh.svg
            :target: https://gitter.im/xonsh/xonsh?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
            :alt: Join the chat at https://gitter.im/xonsh/xonsh

    .. image:: https://img.shields.io/badge/%23xonsh%3Afeneas.org-Matrix-green
            :target: https://matrix.to/#/#xonsh:feneas.org
            :alt: Matrix room: #xonsh:feneas.org

    .. image:: https://travis-ci.org/xonsh/xonsh.svg?branch=main
            :target: https://travis-ci.org/xonsh/xonsh
            :alt: Travis

    .. image:: https://ci.appveyor.com/api/projects/status/github/xonsh/xonsh?svg=true
            :target: https://ci.appveyor.com/project/xonsh/xonsh
            :alt: Appveyor

    .. image:: https://img.shields.io/badge/Google%20Cloud%20Shell-xonsh-green
            :target: https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https://github.com/xonsh/xonsh.git
            :alt: Open in Google Cloud Shell
    .. image:: https://codecov.io/gh/xonsh/xonsh/branch/master/graphs/badge.svg?branch=main
            :target: https://codecov.io/github/xonsh/xonsh?branch=main
            :alt: codecov.io

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>`_ or `Github Xontribs <https://github.com/topics/xontrib>`_ - 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.


The xonsh shell community
*************************

The xonsh shell is developed by a community of volunteers and has no organization that can get grants, donations or additional support. There are two major ways to help the xonsh shell: to spread the good word about xonsh in the world (`write a tweet`_) and to help improve the xonsh shell (`solve an issue <https://github.com/xonsh/xonsh/issues?q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc>`_). We welcome new contributors!

.. _write a tweet: https://twitter.com/intent/tweet?text=xonsh%20is%20a%20Python-powered,%20cross-platform,%20Unix-gazing%20shell%20language%20and%20command%20prompt.&url=https://github.com/xonsh/xonsh