mirror of
https://github.com/xonsh/xonsh.git
synced 2025-03-04 08:24:40 +01:00
🐚 Python-powered shell. Full-featured and cross-platform.
artificial-intelligencebashclicommand-lineconsoledata-engineeringdata-sciencedevopsfishiterm2pythonraspberry-pisecurity-automationshellxonshzsh
| .github | ||
| appimage | ||
| ci | ||
| docs | ||
| news | ||
| requirements | ||
| scripts | ||
| tests | ||
| xonsh | ||
| xontrib | ||
| .authors.yml | ||
| .coveragerc | ||
| .gitattributes | ||
| .gitignore | ||
| .mailmap | ||
| .pre-commit-config.yaml | ||
| .travis.yml | ||
| amalgamate.py | ||
| AUTHORS.rst | ||
| CHANGELOG.rst | ||
| conftest.py | ||
| CONTRIBUTING.rst | ||
| github_deploy_key.enc | ||
| license | ||
| logo.txt | ||
| Makefile | ||
| MANIFEST.in | ||
| pyproject.toml | ||
| README.rst | ||
| release.xsh | ||
| rever.xsh | ||
| run-tests.xsh | ||
| scent.py | ||
| setup.cfg | ||
| setup.py | ||
| travis.yml | ||
| xonsh-in-docker.py | ||
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