Xonsh

.. raw:: html

<img src="https://avatars.githubusercontent.com/u/17418188?s=200&v=4" alt="Xonsh shell icon." align="left" width="100px">

Xonsh (sounds like "consh") is a full-featured and cross-platform Python-based shell. The language is a superset of Python 3 with seamless integration of shell functionality and commands. It works on all major platforms, including Linux, macOS, Windows, BSD, Jupyter, Android, Raspberry Pi and Nix.

.. raw:: html

<br clear="left"/>

.. list-table:: :widths: 1 1

• • Xonsh is the Shell
  • Xonsh is Python

• • .. code-block:: shell

    cd $HOME

    id $(whoami) > ~/id.txt

    cat /etc/passwd | grep root

    $PROMPT = '@ '

  • .. code-block:: python

    2 + 2

    var = "hello".upper()

    @.imp.json.loads('{"a":1}')

    [i for i in range(0,10)]

• • Xonsh is the Shell in Python
  • Xonsh is Python in the Shell

• • .. code-block:: python

    len($(curl -L https://xon.sh))

    $PATH.append('/tmp')

    p'/etc/passwd'.read_text().find('usr')

    $(@json podman ps --format json)['ID']

  • .. code-block:: python

    name = 'snail' echo @(name) > /tmp/@(name)

    with p'/tmp/dir'.mkdir().cd(): touch @(input('File: '))

    aliases['e'] = 'echo @(2+2)' aliases['a'] = lambda args: print(args)

• • Xonsh is Everywhere
  • Xonsh is an Ecosystem

• • .. code-block:: python

    $PATH

    ['/bin', '/sbin'] # Linux

    ['/homebrew/bin'] # macOS

    ['/usr/local/bin'] # FreeBSD

    ['/mnt/c/Windows/System32'] # WSL

    [r'c:\Windows\System32'] # Windows

    ['/nix/store/0-python/bin'] # Nix

    ['/data/termux/usr/bin'] # Termux

    ['/tmp/.mount_x/usr/bin/'] # AppImage

    ['/app/bin'] # Flatpak

    $PATH = ['/my/own/path']

  • .. code-block:: python

    xontrib load term_integration
    prompt_starship
    powerline
    dracula
    chatgpt
    django
    jupyter
    1password
    github_copilot
    history_encrypt

• • Xonsh is a Meta-Shell
  • Xonsh is User-extensible

• • .. code-block:: python

    xontrib load sh
    fish_completer

    osqueryi ! SELECT platform FROM os_version

    def nudf(cmd): return @.imp.pandas.DataFrame( $(@json nu -c @(cmd+'| to json'))) nudf!(ls -la)

    aliases['ai'] = 'ollama run llama3' ai! how to remove images in podman

  • .. code-block:: python

    @events.on_ptk_create def custom_keybindings(bindings, **kw): @bindings.add(Keys.ControlI) def say_whoami(event): echo $(whoami)

    @events.on_postcommand def _prompt_err_cmd(cmd, rtn, out, ts): if rtn != 0: $XONSH_PROMPT_NEXT_CMD = cmd.rstrip()

If you like xonsh, :star: the repo and spread the word about xonsh.

.. class:: center

.. image:: https://img.shields.io/badge/Zulip%20Community-xonsh-green
        :target: https://xonsh.zulipchat.com/
        :alt: Join to xonsh.zulipchat.com

.. image:: https://repology.org/badge/tiny-repos/xonsh.svg
        :target: https://repology.org/project/xonsh/versions
        :alt: repology.org

.. image:: https://img.shields.io/badge/Docker%20Hub-xonsh-blue
        :target: https://hub.docker.com/u/xonsh
        :alt: hub.docker.com

.. image:: https://img.shields.io/badge/AppImage-xonsh-lightblue
        :target: https://xon.sh/appimage.html
        :alt: AppImage

.. image:: https://github.com/xonsh/xonsh/actions/workflows/test.yml/badge.svg
        :target: https://github.com/xonsh/xonsh/actions/workflows/test.yml
        :alt: GitHub Actions

First steps

---

• Installation <https://xon.sh/install.html>_ - isolated environment, package, container or portable AppImage.
• Tutorial <https://xon.sh/tutorial.html>_ - step by step introduction in Xonsh.

Extensions

---

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

• Xontribs on Github <https://github.com/topics/xontrib>_
• Awesome xontribs <https://github.com/xonsh/awesome-xontribs>_
• Core xontribs <https://xon.sh/api/_autosummary/xontribs/xontrib.html>_
• Create a xontrib step by step from template <https://github.com/xonsh/xontrib-template>_

Projects that use Xonsh or compatible

---

This is the beginning of the README. Read the rest at the original. Read the full README ↗