Question 1

How do I install complgen on Linux?

Accepted Answer

Install via Cargo with `cargo install --git https://github.com/adaszko/complgen --tag v0.8.3 complgen`, or download pre-built binaries from GitHub releases. For Bash, ensure the bash-completion package is installed.

Question 2

What's the difference between complgen and compgen?

Accepted Answer

complgen is a tool for generating completion scripts from declarative grammars across multiple shells, while compgen is a bash-specific built-in command for generating completions. complgen offers a unified syntax, whereas compgen is limited to Bash.

Question 3

How can I add descriptions to my completions in complgen?

Accepted Answer

In the grammar, follow a literal with a quoted string, e.g., `grep --extended-regexp "PATTERNS are extended regular expressions";`. This adds hints in fish, zsh, and PowerShell, but not in bash due to shell limitations.

Question 4

Does complgen work with Windows PowerShell 5.x?

Accepted Answer

No, complgen requires PowerShell Core 7+ (pwsh) for generating completions, as stated in the caveats. Windows PowerShell 5.x is not supported, so you'll need to upgrade or use an alternative.

Question 5

How do I handle dynamic completions with external commands in complgen?

Accepted Answer

Use the syntax `{{{ echo foo; echo bar; }}}` in the grammar to source candidates. For descriptions, output lines in `COMPLETION	DESCRIPTION` format, and define shell-specific commands with `<USER@bash>` for conditional behavior.

Question 6

Is complgen compatible with existing bash completion scripts?

Accepted Answer

Complgen generates standalone scripts, so it can replace existing ones, but integration might require rewriting them into the declarative grammar. It doesn't directly import or merge with legacy scripts.

complgen

What is complgen?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions