completion

Synopsis

gapline completion <shell> [--install]

Description

completion prints a shell completion script for gapline to stdout, or installs it into the shell’s standard completion directory when --install is passed.

Completion covers:

• Every sub-command and its flags.
• The 17 CRUD targets (stops, routes, trips, …).
• Rule IDs, dynamically suggested from the rules registered with this build — useful for --disable-rule.

Note

Scripts are generated for every clap_complete target, but --install writes to the standard completion directory only for bash, zsh, and fish. For elvish and powershell, generate the script and install it yourself.

Arguments

Argument	Values
<shell>	bash, zsh, fish, elvish, powershell.

Options

Flag	Short	Description
--install		Install the generated script into the shell’s standard completion directory instead of writing it to stdout. Supported for bash, zsh, and fish.

Global flags are listed on reference/global-flags.

Examples

Generate the script to stdout

gapline completion bash
gapline completion zsh
gapline completion fish
gapline completion elvish
gapline completion powershell

Install for the current user

gapline completion bash --install
gapline completion zsh --install
gapline completion fish --install

Restart your shell or source the new file to pick up the completions.

Manual install fallback

If --install is not available for your shell (or you prefer an explicit path), redirect the generated script yourself:

gapline completion bash > ~/.local/share/bash-completion/completions/gapline
gapline completion zsh  > "${fpath[1]}/_gapline"
gapline completion fish > ~/.config/fish/completions/gapline.fish

Troubleshooting

• Nothing completes after install. Most shells load completion scripts on startup. Open a new terminal or source the new file.
• zsh reports “_arguments:comparguments:327: can only be called from completion function”. Make sure compinit runs in your .zshrc before the completion file is sourced.
• Rule IDs do not complete. The dynamic rule-ID completer needs the binary on your PATH. Verify with gapline --version.

Exit codes

Code	Meaning
0	Script generated or installed successfully.
3	Installation failed (permission denied, directory not writable).

See concepts/exit-codes for the complete table.

See also

• Getting started / Shell completion — step-by-step setup.
• gapline rules list — every rule ID that completion suggests.