Skip to content

alberti42/zsh-misc-completions

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Zsh autocompletion plugin for miscellaneous commands

This repository contains a collection of miscellaneous Zsh completions for various tools. These completions are designed to enhance your command-line experience by providing autocompletion for commands and their options.

Contents

Directory Structure

├── src
│   ├── _brctl
│   ├── _fileproviderctl
│   ├── _mbsync
│   ├── _pytr
│   ├── _qpdf
│   └── _sshuttle
└── zsh-misc-completions.plugin.zsh
  • src/: Contains individual completion scripts for specific commands.
    • _brctl: Completion for brctl (bridge management tool).
    • _fileproviderctl: Completion for fileproviderctl.
    • _mbsync: Completion for mbsync (mail synchronization tool).
    • _pytr: Completion for pytr.
    • _qpdf: Completion for qpdf (PDF transformation tool).
    • _sshuttle: Completion for sshuttle (VPN over SSH).
  • zsh-misc-completions.plugin.zsh: Main plugin script to load all the completions.

Installation

Using a Zsh Plugin Manager

Add this repository to your Zsh plugin manager.

Zinit

With zinit, you can add the plugin as follows:

zinit wait for lucid light-mode as'completion' proto'ssh' from'github' compile'src/_*' @alberti42/zsh-misc-completions

Oh My Zsh

To use with Oh My Zsh:

  1. Clone the repository into the custom plugins directory:

    git clone https://github.com/alberti42/zsh-misc-completions.git ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-misc-completions
  2. Add zsh-misc-completions to the list of plugins in your ~/.zshrc:

    plugins=(... zsh-misc-completions)
  3. Restart your terminal or source your ~/.zshrc:

    source ~/.zshrc

Manual Installation

  1. Clone this repository:

    git clone https://github.com/<your-github-username>/zsh-misc-completions.git ~/.zsh/zsh-misc-completions
  2. Source the plugin script in your ~/.zshrc:

    source ~/.zsh/zsh-misc-completions/zsh-misc-completions.plugin.zsh
  3. Restart your terminal or source your Zsh configuration:

    source ~/.zshrc

Usage

Once installed, the completions will be automatically available for the supported commands. Type the command and press Tab to see the available options.

Contributing

Contributions are welcome! If you have a completion script for a tool that is not currently included, feel free to submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages