Windows Guide


To install xonsh on Windows, first install Python v3.4+ from .

Next, install the other dependencies via pip:

> pip install ply
> pip install prompt-toolkit

While prompt-toolkit is considered an optional dependency, it’s the recommended alternative to pyreadline for Windows users. Once installed, you have to enable prompt-toolkit by creating ~/.xonshrc file and adding the following:

$SHELL_TYPE = 'prompt_toolkit'

For Windows, it’s recommended to use a replacement console emulator. Good choices are cmder or conemu.

Download the latest from github and unzip it to xonsh-master.

Now install xonsh:

> cd xonsh-master
> python install


Now you are ready to run xonsh:

> scripts\xonsh
[email protected] ~ $

Due to ambiguity with the Python dir builtin, to list the current directory via the cmd.exe builtin you must explicitly request the ., like this:

>>> dir .
 Volume in drive C is Windows
 Volume Serial Number is 30E8-8B86

 Directory of C:\Users\snail\xonsh

2015-05-12  03:04    <DIR>          .
2015-05-12  03:04    <DIR>          ..
2015-05-01  01:31    <DIR>          xonsh
               0 File(s)              0 bytes
               3 Dir(s)  11,008,000,000 bytes free

Many people create a d alias for the dir command to save typing and avoid the ambiguity altogether:

>>> aliases['d'] = ['cmd', '/c', 'dir']

You can add this alias to your ~/.xonshrc to have it always available when xonsh starts.