使用方法
- 复制安装命令，在自己的智能体环境安装前先检查源码包。
- 从原始文档核对所需工具、凭据和支持的宿主。
- 说明输入材料与期望交付物，并对照来源检查输出。
npx skills add https://github.com/carapace-sh/carapace --skill xonsh开始前需了解
- 安装不包含模型订阅、API 额度或访问文件的权限。
- 仓库星数和安装量反映活跃情况，不等于独立质量或安全测试。
仓库原始内容
按源仓库内容呈现，保留标题、案例、代码、表格、链接以及原文引用的演示图片。
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.
