whatisgithub

What is zsh-completions?

mikachu/zsh-completions — explained in plain English

Analysis updated 2026-08-02 · repo last pushed 2012-06-10

2PythonAudience · developerComplexity · 2/5DormantSetup · easy

In one sentence

A collection of scripts that teach the Zsh terminal shell how to auto-complete commands for programs that lack built-in completion. Install it, and pressing Tab gets smarter for your favorite tools.

Mindmap

mindmap
  root((repo))
    What it does
      Adds tab completion
      Covers many programs
      Community contributed
    Tech stack
      Zsh
      Shell scripts
    Use cases
      Faster typing
      Fewer typos
      Power user workflows
    Audience
      Terminal power users
      Developers
    Setup
      Clone the repo
      Point Zsh at it
      Restart terminal
    Licensing
      Per file basis
      Community maintained

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Add smarter tab-completion for a command-line tool you use that Zsh doesn't autocomplete out of the box.

USE CASE 2

Contribute a new completion script for a program that is missing one.

USE CASE 3

Reduce typos and keystrokes when typing long terminal commands.

What is it built with?

ZshShell scripts

How does it compare?

mikachu/zsh-completions0-bingwu-0/live-interpreter010zx00x1/faresnipe
Stars222
LanguagePythonPythonPython
Last pushed2012-06-10
MaintenanceDormant
Setup difficultyeasymoderateeasy
Complexity2/52/52/5
Audiencedevelopergeneralgeneral

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Requires editing your .zshrc to add the repo to fpath before compinit runs.

Each completion script carries its own license noted inside the file, so you need to check individual files for permissions.

So what is it?

If you use Zsh (a popular alternative to the standard command-line shell on Macs and Linux), you've probably noticed it can auto-complete commands as you type, press Tab and it fills in the rest. The zsh-completions project adds new auto-completion rules for programs that don't have them yet. The goal is to eventually fold these scripts back into Zsh itself once they're polished. At a technical level, each file in the repo is a script that teaches Zsh how to autocomplete a specific program, what arguments are valid, what options exist, and so on. You install it by downloading the repo and pointing Zsh at it, which makes the new completion rules available the next time you start your terminal. This is for developers or power users who spend a lot of time in the terminal and want smarter tab-completion for tools they use regularly. If you type long commands often and want to save keystrokes while avoiding typos, these scripts help Zsh predict what you're trying to type. The project is community-driven, anyone can contribute a completion script for a program that's missing one, following a style guide to keep things consistent. Each script's license is noted individually in its file. The README is fairly minimal and mostly covers installation steps and contribution guidelines rather than listing which programs are supported.

Copy-paste prompts

Prompt 1
I want to install zsh-completions on my Mac. Walk me through cloning the repo and configuring my .zshrc so the new completions load when I start a terminal.
Prompt 2
Help me write a zsh-completions script for a CLI tool I built. Here are the subcommands and flags it supports, generate a completion file following the project's style guide.
Prompt 3
I installed zsh-completions but tab-completion isn't working for any new programs. Help me debug the fpath and compinit setup in my Zsh config.

Frequently asked questions

What is zsh-completions?

A collection of scripts that teach the Zsh terminal shell how to auto-complete commands for programs that lack built-in completion. Install it, and pressing Tab gets smarter for your favorite tools.

What language is zsh-completions written in?

Mainly Python. The stack also includes Zsh, Shell scripts.

Is zsh-completions actively maintained?

Dormant — no commits in 2+ years (last push 2012-06-10).

What license does zsh-completions use?

Each completion script carries its own license noted inside the file, so you need to check individual files for permissions.

How hard is zsh-completions to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is zsh-completions for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.