Shell completion

Completion saves keystrokes on every gapline invocation. It suggests subcommands, flags, CRUD target names, and — unique to gapline — the IDs of every validation rule compiled into your build, so --disable-rule <Tab> becomes a menu instead of a grep-then-paste ritual.

Install in one command

Bash

gapline completion bash --install

Open a new terminal or source ~/.bashrc to pick up the completion.

Zsh

gapline completion zsh --install

Make sure compinit runs in your .zshrc before any custom completion loader. Start a new shell or source ~/.zshrc.

Fish

gapline completion fish --install

Fish picks up the new file on the next prompt — no restart needed.

Install manually

When --install cannot reach the standard directory (read-only partition, unusual shell setup, a CI runner with no home), generate the script yourself and redirect it to the path that fits your environment.

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

Note

Scripts can also be generated for elvish and powershell, but --install does not know how to drop them into the right place. Generate the script with gapline completion elvish or gapline completion powershell and follow your shell’s documented location.

What gets completed

• Subcommands — validate, read, create, update, delete, run, rules, completion.
• Flags — long forms (--feed, --format, --min-severity…) and their short aliases (-f, -o, -w, -s).
• CRUD targets — the 17 GTFS files accepted by read, create, update, delete (stops, routes, trips, stop-times, …).
• Validation rule IDs — every rule registered in the current binary, suggested as the value of --disable-rule.

Try it

gapline valid<Tab>                       # → validate
gapline validate --m<Tab>                # → --min-severity
gapline validate --disable-rule bloc<Tab># → block_id_trip_overlap
gapline read sto<Tab>                    # → stops  stop-times

Troubleshooting

• Nothing happens on <Tab>. Most shells load completion scripts at startup. Open a new terminal or source the file you just wrote.
• Zsh prints a _arguments:comparguments error. compinit needs to run before the gapline completion is sourced. Check that your .zshrc calls autoload -Uz compinit && compinit before any plugin manager that sources custom completions.
• Rule IDs do not suggest anything. The dynamic rule-ID completer shells out to the gapline binary. Run gapline --version to confirm the binary is on your PATH.

See also

• gapline completion reference — full flag reference.
• gapline rules list — the same rule IDs that completion suggests.
• Validating feeds — how --disable-rule fits into a real workflow.