xonsh / xonsh.github.io

The xonsh website available at http://xon.sh

xonsh

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.

If you like xonsh, ⭐ the repo, write a tweet and stay tuned by watching releases.

First steps

Install xonsh from pip:

python -m pip install 'xonsh[full]'

And visit https://xon.sh for more information:

• Installation - using packages, docker or AppImage.
• Tutorial - step by step introduction in xonsh.

Extensions

Xonsh has an extension/plugin system. We call these additions xontribs.

• Xontribs on Github
• Awesome xontribs
• Core xontribs
• Create a xontrib step by step from template

Projects that use xonsh or compatible

• gitsome: Supercharged Git/shell autocompleter with GitHub integration.
• xxh: Using xonsh wherever you go through the SSH.
• rever: Cross-platform software release tool.
• Regro autotick bot: Regro Conda-Forge autoticker.
• zoxide: A smarter cd command.
• any-nix-shell: xonsh support for the nix run and nix-shell environments of the Nix package manager.

Jupyter-based interactive notebooks via xontrib-jupyter:

• jupyter and jupyterlab: Interactive notebook platform.
• euporie: Terminal based interactive computing environment.

The xonsh shell community

The xonsh shell is developed by a community of volunteers. There are a few ways to help out:

• Solve a popular issue. You can start with the Developer guide.
• Solve a good first issue.
• Take an idea and create a new xontrib.
• Become xonsh core by deep diving into xonsh and improve the threading and subprocess logic.
• Become a sponsor to xonsh.
• Write a tweet, post or an article to spread the good word about xonsh in the world.
• Give a star to xonsh repository and to xontribs you like.

We welcome new contributors!

Credits

• Thanks to Zulip for supporting the xonsh community!

xonsh.github.io's Issues

The live preview on http://xon.sh/ remembers folders created by other users

The live preview on http://xon.sh/ remembers folders created by other users.

I have started the shell with Click to try Xonsh! and typed ls.
There were some folders present with racist and xenophobic names.

HTTPS support is missing

http://xon.sh/ doesn't redirect to https://xon.sh/ and connecting manually to https://xon.sh/ yields an invalid certificate error.

Redirect xonsh.org to xon.sh

I imagine I'm probably not the only newbie interested in this project who found himself on the rather broken http://xonsh.org/ (docs for 0.24) which is the third in the list on a Google search for xonsh (xon.sh is first).