Skip to content

completions flag is undocumented; shell coverage and install path unclear #1639

Description

@Widthdom

Summary

The CLI exposes a --completions flag (or a completions subcommand) for shell completion script generation, but it is not advertised in --help, not mentioned in USER_GUIDE.md, and the install path / per-shell coverage (bash/zsh/fish/powershell) is unclear. Users who would benefit (heavy shell users) cannot discover it.

Where

  • src/CodeIndex/Cli/ProgramRunner.cs (completion entry point)
  • USER_GUIDE.md (no completion install instructions)

Suggested approach

(1) Add a top-level "Shell completions" section to USER_GUIDE.md with one-liner install commands per shell. (2) Document supported shells explicitly. (3) Surface the flag in --help output. (4) If only bash is currently supported, file follow-up work for zsh/fish/pwsh.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions