sprocket completions
sprocket can generate command-line completion scripts for various shells, allowing you to use tab completion for commands and arguments.
Warning
The interfaces of established commands are relatively settled, but Sprocket is still pre-1.0: commands, flags, and arguments can change between versions, and they change most often for the experimental commands under the dev namespace (see project status). You will need to regenerate the shell completion script using the steps below each time you update sprocket, so that completions match the version you have installed.
To generate a completion script, use the completions subcommand, specifying your shell:
sprocket completions <SHELL>Supported shells are: bash, elvish, fish, powershell and zsh. The script is written to standard output, so redirect it to a file to save it.
Enabling Completions
The exact steps to correctly enable shell completions depend on your specific shell and how it's configured. Generally it involves two main steps:
- Run the
sprocket completions <your shell>command and redirect its standard output into a file, often somewhere in your home directory. For example, a Bash user might run:
sprocket completions bash > ~/.bash_completions/sprocket.bash- Modify your shell's startup configuration file (e.g.
~/.bashrc,~/.zshrc,~/.config/fish/config.fish, PowerShell's$PROFILE, Elvish's~/.config/elvish/rc.elv) to source the file you just created. Continuing the Bash example, add this line to your~/.bashrc
source ~/.bash_completions/sprocket.bashOpen a new shell (or re-source the startup file) for completions to take effect.