- the xonsh shell
- Comparison
- Installation
- Dependencies
- Development Dependencies
- News & Media
- Guides
- Tutorial
- Starting xonsh
- Basics
- Environment Variables
- Running Commands
- Python-mode vs Subprocess-mode
- Quoting
- Captured Subprocess with
$()
and!()
- Uncaptured Subprocess with
$[]
and![]
- Python Evaluation with
@()
- Command Substitution with
@$()
- Nesting Subprocesses
- Pipes
- Logical Subprocess And
- Logical Subprocess Or
- Input/Output Redirection
- Background Jobs
- Job Control
- String Literals in Subprocess-mode
- Filename Globbing with
*
- Advanced Path Search with Backticks
- Help & Superhelp with
?
&??
- Compile, Evaluate, & Execute
- Aliases
- Up, Down, Tab
- Customizing the Prompt
- Executing Commands and Scripts
- Importing Xonsh (
*.xsh
) - That’s All, Folks
- Tutorial: History
- How is xonsh history different?
- Why have rich history?
history
commandshow
actionid
actionfile
actioninfo
actionreplay
actiondiff
actiongc
action- History Indexing
- Exciting Technical Detail: Lazy JSON
- Exciting Technical Detail: Teeing and Pseudo Terminals
- Sqlite History Backend
- Fun ideas for history data
- Tutorial: Macros
- Tutorial: Extensions (Xontribs)
- Tutorial: Events
- Tutorial: Programmable Tab-Completion
- Tutorial: Write Your Own History Backend
- Tutorial: Subprocess Strings
- Tutorial:
prompt_toolkit
custom keybindings - Bash to Xonsh Translation Guide
- Subprocess Types Table
- Python Virtual Environments
- Tutorial
- Config Files and Settings
- Contributing
- Contact Us
- Helpful Links
- Development Spiral
- Xonsh API
- Lexer (
xonsh.lexer
) - Parser (
xonsh.parser
) - Abstract Syntax Tree (
xonsh.ast
) - Compilation, Evaluation, & Execution (
xonsh.execer
) - Import Hooks (
xonsh.imphooks
) - Built-Ins (
xonsh.built_ins
) - Environment (
xonsh.environ
) - Aliases (
xonsh.aliases
) - Directory Stack (
xonsh.dirstack
) - Job Control (
xonsh.jobs
) - Python Procedures as Subprocess Commands (
xonsh.proc
) - Object Inspectors (
xonsh.inspectors
) - Xonsh History API
- Tab Completer (
xonsh.completer
) - Completers API
- Prompt formatter API
- Main Shell Command Prompt (
xonsh.shell
) - Base Shell Class (
xonsh.base_shell
) - Readline Shell (
xonsh.readline_shell
) - Prompt Toolkit Shell (
xonsh.ptk.shell
) - Prompt Toolkit History Object (
xonsh.ptk.history
) - Prompt Toolkit Completer (
xonsh.ptk.completer
) - Prompt Toolkit Key Bindings (
xonsh.ptk.key_bindings
) - Pretty printing (
xonsh.pretty
) - Replay History (
xonsh.replay
) - History Diff’er (
xonsh.diff_history
) - Core Utilities API
- Events (
xonsh.events
) - Tools (
xonsh.tools
) - Platform-specific constants and implementations (
xonsh.platform
) - JSON Utilities (
xonsh.jsonutils
) - Lazy JSON Files (
xonsh.lazyjson
) - Lazy & Self-destructive Objects (
xonsh.lazyasd
) - Open Python Files (
xonsh.openpy
) - Foreign Shell Tools (
xonsh.foreign_shells
) - Commands Cache (
xonsh.commands_cache
) - Tracer (
xonsh.tracer
) - Command Line Interface (
xonsh.main
) - Color Tools (
xonsh.color_tools
) - Pygments Hooks (
xonsh.pyghooks
) - Jupyter Kernel (
xonsh.jupyter_kernel
) - Wizard Making Tools (
xonsh.wizard
) - Xonsh Configuration Utility (
xonsh.xonfig
) - Compiling and Caching of Xonsh Code (
xonsh.codecache
) - Context Managers for Xonsh (
xonsh.contexts
) - Matplotlib Hooks (
xontrib.mplhooks
) - Vox (
xontrib.voxapi
)
- Lexer (
- Advanced Events
- Xonsh Change Log
- Frequently Asked Questions
- Wishlist & To-Dos
- Xonsh API
- the xonsh shell
- Comparison
- Installation
- Dependencies
- Development Dependencies
- News & Media
- Guides
- Tutorial
- Starting xonsh
- Basics
- Environment Variables
- Running Commands
- Python-mode vs Subprocess-mode
- Quoting
- Captured Subprocess with
$()
and!()
- Uncaptured Subprocess with
$[]
and![]
- Python Evaluation with
@()
- Command Substitution with
@$()
- Nesting Subprocesses
- Pipes
- Logical Subprocess And
- Logical Subprocess Or
- Input/Output Redirection
- Background Jobs
- Job Control
- String Literals in Subprocess-mode
- Filename Globbing with
*
- Advanced Path Search with Backticks
- Help & Superhelp with
?
&??
- Compile, Evaluate, & Execute
- Aliases
- Up, Down, Tab
- Customizing the Prompt
- Executing Commands and Scripts
- Importing Xonsh (
*.xsh
) - That’s All, Folks
- Tutorial: History
- How is xonsh history different?
- Why have rich history?
history
commandshow
actionid
actionfile
actioninfo
actionreplay
actiondiff
actiongc
action- History Indexing
- Exciting Technical Detail: Lazy JSON
- Exciting Technical Detail: Teeing and Pseudo Terminals
- Sqlite History Backend
- Fun ideas for history data
- Tutorial: Macros
- Tutorial: Extensions (Xontribs)
- Tutorial: Events
- Tutorial: Programmable Tab-Completion
- Tutorial: Write Your Own History Backend
- Tutorial: Subprocess Strings
- Tutorial:
prompt_toolkit
custom keybindings - Bash to Xonsh Translation Guide
- Subprocess Types Table
- Python Virtual Environments
- Tutorial
- Config Files and Settings
- Contributing
- Development Spiral
- Xonsh API
- Lexer (
xonsh.lexer
) - Parser (
xonsh.parser
) - Abstract Syntax Tree (
xonsh.ast
) - Compilation, Evaluation, & Execution (
xonsh.execer
) - Import Hooks (
xonsh.imphooks
) - Built-Ins (
xonsh.built_ins
) - Environment (
xonsh.environ
) - Aliases (
xonsh.aliases
) - Directory Stack (
xonsh.dirstack
) - Job Control (
xonsh.jobs
) - Python Procedures as Subprocess Commands (
xonsh.proc
) - Object Inspectors (
xonsh.inspectors
) - Xonsh History API
- Tab Completer (
xonsh.completer
) - Completers API
- Prompt formatter API
- Main Shell Command Prompt (
xonsh.shell
) - Base Shell Class (
xonsh.base_shell
) - Readline Shell (
xonsh.readline_shell
) - Prompt Toolkit Shell (
xonsh.ptk.shell
) - Prompt Toolkit History Object (
xonsh.ptk.history
) - Prompt Toolkit Completer (
xonsh.ptk.completer
) - Prompt Toolkit Key Bindings (
xonsh.ptk.key_bindings
) - Pretty printing (
xonsh.pretty
) - Replay History (
xonsh.replay
) - History Diff’er (
xonsh.diff_history
) - Core Utilities API
- Events (
xonsh.events
) - Tools (
xonsh.tools
) - Platform-specific constants and implementations (
xonsh.platform
) - JSON Utilities (
xonsh.jsonutils
) - Lazy JSON Files (
xonsh.lazyjson
) - Lazy & Self-destructive Objects (
xonsh.lazyasd
) - Open Python Files (
xonsh.openpy
) - Foreign Shell Tools (
xonsh.foreign_shells
) - Commands Cache (
xonsh.commands_cache
) - Tracer (
xonsh.tracer
) - Command Line Interface (
xonsh.main
) - Color Tools (
xonsh.color_tools
) - Pygments Hooks (
xonsh.pyghooks
) - Jupyter Kernel (
xonsh.jupyter_kernel
) - Wizard Making Tools (
xonsh.wizard
) - Xonsh Configuration Utility (
xonsh.xonfig
) - Compiling and Caching of Xonsh Code (
xonsh.codecache
) - Context Managers for Xonsh (
xonsh.contexts
) - Matplotlib Hooks (
xontrib.mplhooks
) - Vox (
xontrib.voxapi
)
- Lexer (
- Advanced Events
- Xonsh Change Log
- Frequently Asked Questions
- Wishlist & To-Dos
- Xonsh API
- API
- Lexer (
xonsh.lexer
) - Parser (
xonsh.parser
) - Abstract Syntax Tree (
xonsh.ast
) - Compilation, Evaluation, & Execution (
xonsh.execer
) - Import Hooks (
xonsh.imphooks
) - Built-Ins (
xonsh.built_ins
) - Environment (
xonsh.environ
) - Aliases (
xonsh.aliases
) - Directory Stack (
xonsh.dirstack
) - Job Control (
xonsh.jobs
) - Python Procedures as Subprocess Commands (
xonsh.proc
) - Object Inspectors (
xonsh.inspectors
) - Xonsh History API
- Tab Completer (
xonsh.completer
) - Completers API
- Base Completer (
xonsh.completers.base
) - Bash Completers (
xonsh.completers.bash
) - First Command Completer (
xonsh.completers.commands
) - Directory Completers (
xonsh.completers.dirs
) - Manual Page Based Completers (
xonsh.completers.man
) - File System Path Completer (
xonsh.completers.path
) - Python Completer (
xonsh.completers.python
) - Completion Tools (
xonsh.completers.tools
) - Completion Xompletions (
xonsh.completers.xompletions
)
- Base Completer (
- Prompt formatter API
- Base prompt formatter (
xonsh.prompt.base
) - CWD related prompt formatter (
xonsh.prompt.cwd
) - Virtualenv prompt formatter (
xonsh.prompt.env
) - Informative git status prompt formatter (
xonsh.prompt.gitstatus
) - Jobs prompt formatter (
xonsh.prompt.job
) - Version control branch info prompt formatter (
xonsh.prompt.vc
)
- Base prompt formatter (
- Main Shell Command Prompt (
xonsh.shell
) - Base Shell Class (
xonsh.base_shell
) - Readline Shell (
xonsh.readline_shell
) - Prompt Toolkit Shell (
xonsh.ptk.shell
) - Prompt Toolkit History Object (
xonsh.ptk.history
) - Prompt Toolkit Completer (
xonsh.ptk.completer
) - Prompt Toolkit Key Bindings (
xonsh.ptk.key_bindings
) - Pretty printing (
xonsh.pretty
) - Replay History (
xonsh.replay
) - History Diff’er (
xonsh.diff_history
) - Core Utilities API
- Events (
xonsh.events
) - Tools (
xonsh.tools
) - Platform-specific constants and implementations (
xonsh.platform
) - JSON Utilities (
xonsh.jsonutils
) - Lazy JSON Files (
xonsh.lazyjson
) - Lazy & Self-destructive Objects (
xonsh.lazyasd
) - Open Python Files (
xonsh.openpy
) - Foreign Shell Tools (
xonsh.foreign_shells
) - Commands Cache (
xonsh.commands_cache
) - Tracer (
xonsh.tracer
) - Command Line Interface (
xonsh.main
) - Color Tools (
xonsh.color_tools
) - Pygments Hooks (
xonsh.pyghooks
) - Jupyter Kernel (
xonsh.jupyter_kernel
) - Wizard Making Tools (
xonsh.wizard
) - Xonsh Configuration Utility (
xonsh.xonfig
) - Compiling and Caching of Xonsh Code (
xonsh.codecache
) - Context Managers for Xonsh (
xonsh.contexts
) - Matplotlib Hooks (
xontrib.mplhooks
) - Vox (
xontrib.voxapi
)
- Lexer (
- Contact Us
- Helpful Links