How to use
- Copy the installation command and review the source package before installing it in your own agent environment.
- Check the source document for required tools, credentials and supported hosts.
- Describe your input and desired deliverable; review the output against the source material.
npx skills add https://github.com/carapace-sh/carapace --skill xonshBefore you start
- Installation does not include a model subscription, API allowance or permission to access your files.
- Repository stars and installation counts describe activity, not an independent quality or security test.
Original skill document
Rendered from the source repository. Headings, examples, code, tables, links, and referenced images are preserved.
Xonsh Shell In-Depth Reference
Comprehensive reference for xonsh shell internals, with emphasis on the completion system and how external tools hook into it.
Sub-Resources
Load the reference that matches your task. When in doubt, load multiple references.
| Keywords | Reference |
|---|---|
| RichCompletion, CommandContext, CommandArg, CompletionContext, contextualcommandcompleter, contextualcommandcompleterfor, nonexclusivecompleter, addonecompleter, Completer class, completer pipeline, exclusive vs non-exclusive, deduplication, sorting tiers, filter function, prefixlen, appendclosingquote, appendspace, display, description, style, provider, tagprovider, applylprefix, completefromsubproc, compbasedcompleter, oncompleterfilter, XONSHCOMPLETERMODE, XONSHCOMPLETERTRACE, COMPLETIONQUERYLIMIT, XONSHCOMPLETERDIRS, CommandCompleter, xompletions, bash completion bridge, path completer, command completer, python completer, base completer | references/completion.md |
| PromptToolkitShell, PromptToolkitCompleter, PromptSession, Completion, CompleteStyle, key bindings, onptkcreate, COMPLETIONSDISPLAY, COMPLETIONMODE, COMPLETIONSCONFIRM, COMPLETIONSMENUROWS, UPDATECOMPLETIONSONKEYPRESS, COMPLETIONINTHREAD, AUTOSUGGESTINCOMPLETIONS, XONSHPROMPTAUTOSUGGEST, auto-suggest, menu-complete, displaymeta, highlightmatch, unquote, ptk shell, vi mode, emacs mode, XONSHAUTOPAIR | references/prompt-toolkit.md |
| Python-powered shell, subprocess execution, SubprocSpec, CommandPipeline, capture modes, $() vs !() vs $[] vs ![], pipe redirect, a>p, e>p, subprocess syntax, Python expressions, shell expressions, @(), $(), ![], subprocess wrapping, quoting, string literals, raw strings, p-strings, f-strings, path strings, word splitting, glob expansion, tilde expansion, environment access, $VAR, ${VAR}, ${{VAR}}, alias system, callable alias, ExecAlias | references/language-execution.md |
| rc.xsh, .xonshrc, XONSHRC, XONSHRCDIR, XONSHCONFIGDIR, xontrib, xontrib load, xontrib list, loadxontrib, unloadxontrib, entry points, event system, Event, LoadEvent, EventManager, onchdir, onprecommand, onpostcommand, oncommandnotfound, onpreprompt, onpostprompt, onenvvarchange, ontransformcommand, onexit, onptkcreate, oncompleterfilter, XSH, XSH.env, XSH.completers, XSH.commandscache, XSH.builtins, environment variables, Env class, Var, VarPattern, detype, LsColors, EnvPath, XONSH* env vars, BASHCOMPLETIONS, COMPLETEDOTS, SUBSEQUENCEPATHCOMPLETION, FUZZYPATHCOMPLETION, SUGGESTTHRESHOLD, CMDCOMPLETIONSSHOWDESC, ALIASCOMPLETIONSOPTIONSBYDEFAULT | references/startup-config.md |
Quick Guide
- How do I write a contextual completer? → references/completion.md
- How does the completer pipeline work? → references/completion.md
- What is RichCompletion and its fields? → references/completion.md
- How do I register a completer with add_one_completer? → references/completion.md
- How does exclusive vs non-exclusive work? → references/completion.md
- How does the bash completion bridge work? → references/completion.md
- How does prompt-toolkit render completions? → references/prompt-toolkit.md
- How do I configure completion display? → references/prompt-toolkit.md
- How do I add custom key bindings? → references/prompt-toolkit.md
- How does xonsh execute subprocess commands? → references/language-execution.md
- What are the capture modes ($() vs !())? → references/language-execution.md
- How does quoting work in xonsh? → references/language-execution.md
- How do I set up rc.xsh? → references/startup-config.md
- How do I write a xontrib? → references/startup-config.md
- How does the event system work? → references/startup-config.md
- What are the XONSH_ environment variables?** → references/startup-config.md
Cross-Project References
- For carapace-specific xonsh integration (snippet, patch phase, value formatting, JSON output, style conversion), see the carapace-dev skill →
references/shell-xonsh.md.
