Xonsh API¶
For those of you who want the gritty details.
Xonsh Standard Library:
Language:
Command Prompt:
- 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 2 Shell (
xonsh.ptk2.shell) - Prompt Toolkit 2 History Object (
xonsh.ptk2.history) - Prompt Toolkit 2 Completer (
xonsh.ptk2.completer) - Prompt Toolkit 2 Key Bindings (
xonsh.ptk2.key_bindings) - Pretty printing (
xonsh.pretty) - Replay History (
xonsh.replay) - History Diff’er (
xonsh.diff_history) - Core Utilities API
Helpers:
- 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) - Jupyter Shell (
xonsh.jupyter_shell) - Dumb Shell (
xonsh.dumb_shell) - Wizard Making Tools (
xonsh.wizard) - Xonsh Configuration Utility (
xonsh.xonfig) - Compiling and Caching of Xonsh Code (
xonsh.codecache) - Context Managers for Xonsh (
xonsh.contexts)
Xontribs:
Pending Deprecation:
