OpenParable
Skip to content
← Back to skills

Zsh

Apps & Automation
zsh

Zsh is an Agent Skill for apps & automation published in the carapace-sh/carapace repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use when working with zsh shell internals — completion system (compsys), compinit, compdef, compadd, _describe, _arguments, _alternative, _values, _multi_parts, _sep_parts, _regex_arguments, zstyle, matcher specification, tag system, ZLE widgets, keymaps, bindkey, compstate, quoting, parameter expansion, globbing, startup files, fpath, autoload, or compinstall. Triggers on: "zsh", "zsh completion", "zsh compinit", "zsh compdef", "zsh compadd", "zsh _describe", "zsh _arguments", "zsh zstyle", "zsh matcher", "zsh ZLE", "zsh widget", "zsh bindkey", "zsh compstate", "zsh quoting", "zsh expansion", "zsh globbing", "zsh startup", "zsh fpath", "zsh autoload", "zsh compinstall", "zsh list-colors", "zsh tag-order", "zsh group-name", "zsh menu-select", "zsh menu-complete", "curcontext", "words", "CURRENT", "PREFIX", "SUFFIX", "compquote", "comptilde", "compset", "zpty", "capture completion", "compadd override", "compprefuncs", "comppostfuncs".

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/carapace-sh/carapace/blob/HEAD/skills/zsh/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/zsh, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Zsh Shell In-Depth Reference

Comprehensive reference for zsh 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.

KeywordsReference
compinit, compdef, compadd, _describe, _arguments, _alternative, _values, _multi_parts, _sep_parts, _regex_arguments, _regex_words, _combination, _sequence, _path_files, _files, _gnu_generic, _wanted, _requested, _next_label, _all_labels, _tags, _message, _setup, _pick_variant, _call_function, _dispatch, _normal, _generic, _guard, _store_cache, _retrieve_cache, _cache_invalid, tag system, tag-order, group-name, group-order, zstyle, list-colors, matcher, matcher-list, completer, curcontext, context format, special parameters (words, CURRENT, PREFIX, SUFFIX, IPREFIX, ISUFFIX, QIPREFIX, QISUFFIX), opt_args, val_args, line, state, context, NORMARG, service, _compskip, expl, compinstall, bashcompinit, #compdef directive, _complete, _approximate, _correct, _expand, _history, _match, _prefix, _list, _menu, _oldlist, _ignored, _user_expand, _all_matches, how external tools hook in, completion dispatch flow, completion cachingreferences/completion.md
ZLE, zle builtin, widget, keymap, bindkey, emacs, viins, vicmd, main, .safe, isearch, complete-word, menu-complete, menu-select, reverse-menu-complete, delete-char-or-list, list-choices, expand-or-complete, accept-and-menu-complete, compstate, compwidget, compquote, comptilde, compset, compcall, BUFFER, CURSOR, LBUFFER, RBUFFER, KEYMAP, WIDGET, KEYS, NUMERIC, CONTEXT, vared, zle_highlight, KEYTIMEOUT, user-defined widget, completion widget, zle -C, zle -Nreferences/zle.md
quoting, single quotes, double quotes, $'...' ANSI-C quoting, backslash escaping, RC_QUOTES, parameter expansion, ${name}, ${name:-word}, ${name:=word}, ${name:+word}, ${name:?word}, ${#name}, ${name#pattern}, ${name##pattern}, ${name%pattern}, ${name%%pattern}, ${(flags)name}, expansion flags, globbing, filename generation, *, ?, [...], , **/, glob qualifiers, extended glob, (#b), (#i), ksh glob, expansion order, tilde expansion, brace expansion, process substitution, command substitution, arithmetic expansion, WORDCHARS, FIGNORE, nullglob, nomatchreferences/expansion-quoting.md
startup, .zshenv, .zshprofile, .zshrc, .zlogin, .zlogout, ZDOTDIR, login shell, interactive shell, fpath, FPATH, autoload, compinit security, compaudit, zcompdump, compinit -C, compinit -D, compinit -u, compinit -i, compinstall, RCS, GLOBAL_RCS, completion function discovery, #compdef, _compdir, completion directories, Base, Zsh, Unix, X, platform-specific completionsreferences/startup-config.md
zpty, capture completion, compadd override, compprefuncs, comppostfuncs, compadd -A, compadd -D, zparseopts, headless zsh, pty completion capture, carapace-bridge, Valodim, capture.zsh, completion capture consumer, null-byte framingreferences/capture-completion.md

Quick Guide

Cross-Project References

  • For carapace-specific zsh integration (snippet, quoting state machine, zstyle generation, _describe protocol, named directories), see the carapace-dev skill → references/shell-zsh.md.