OSX Guide

Installation

You can install xonsh using homebrew, conda, pip, or from source.

homebrew:

$ brew install xonsh

conda:

$ conda install -c conda-forge xonsh

Note

For the bleeding edge development version use conda install -c xonsh/channel/dev xonsh

pip:

$ pip install xonsh

source: Download the source from github (zip file), then run the following from the source directory,

$ python setup.py install

Additional Setup

If you want to use xonsh as your default shell, you will first have to add xonsh to /etc/shells.

First ensure that xonsh is on your $PATH

$ which xonsh

Then, as root, add xonsh to the shell list

# echo $(which xonsh) >> /etc/shells

To change shells, run

$ chsh -s $(which xonsh)

You will have to log out and log back in before the changes take effect.

Dependencies

Xonsh currently has the following external dependencies,

Run Time:

  1. Python v3.4+
  2. PLY (optional, included with xonsh)
  3. prompt-toolkit (optional)
  4. Jupyter (optional)
  5. setproctitle (optional)
  6. distro (optional)

Documentation:

  1. Sphinx (which uses reStructuredText)
  2. Numpydoc
  3. Cloud Sphinx Theme

GNU Readline

On Mac OSX, it is strongly recommended to install the gnureadline library if using the readline shell. gnureadline can be installed via pip:

$ pip install gnureadline