completions

What problem does it solve?

Manually configuring ZSH shell completions can be a complex and error-prone task, leading to inconsistent behavior or missing autocomplete features for your command-line tools. This Skill provides a standardized, guided approach to creating, managing, and troubleshooting custom ZSH completions, saving you development time and ensuring a smooth command-line experience.

Core Features & Use Cases

• Standardized Completion Structure: Learn and apply consistent conventions for file naming (<topic>/completion.zsh) and loading, ensuring your custom completions integrate seamlessly with your dotfiles.
• Detailed Syntax Guide: Access clear examples and explanations for registering completions (compdef), defining options (_arguments), handling subcommands (_describe), and utilizing common completers (_files, _directories).
• Troubleshooting & Testing: Benefit from dedicated sections on common issues and a robust testing workflow to quickly validate your custom completions and resolve problems.
• Use Case: You've developed a new CLI tool and want to provide a rich autocomplete experience for its commands, options, and arguments. This Skill guides you step-by-step through creating the completion.zsh file, defining its structure, and testing it to ensure users can effortlessly navigate your tool, boosting their productivity.

Quick Start

Example: Define and register a simple completion for 'mytool'

This snippet shows how to create a basic completion function

and link it to your command.

_mytool() { local -a options=( '-h[Display help]' '--version[Show version]' ) _arguments "${options[@]}" } compdef _mytool mytool