Skip to content

Fix incomplete shell completion help text#63

Merged
sammcj merged 3 commits intomainfrom
copilot/fix-help-documentation-issue
Jan 18, 2026
Merged

Fix incomplete shell completion help text#63
sammcj merged 3 commits intomainfrom
copilot/fix-help-documentation-issue

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 17, 2026

The ingest completion --help output had truncated Fish shell instructions and lacked persistent installation guidance for all shells.

Before:

Long: `To load completions: Bash: $ source <(ingest completion bash) Zsh: $ source <(ingest completion zsh) Fish: $ ingest completion`

Changes:

  • main.go: Expanded completion command help with complete instructions for Bash/Zsh/Fish, including both session-only and persistent installation paths
  • README.md: Added examples for all three shells instead of only Zsh

After:

Fish:
  $ ingest completion fish | source

  To load completions for each session, execute once:
  $ ingest completion fish > ~/.config/fish/completions/ingest.fish
Original prompt

This section details on the original issue you should resolve

<issue_title>fix confusing doco around --help </issue_title>
<issue_description></issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

- Expanded completion command help text with detailed instructions for all shells
- Added proper Fish completion command (was previously truncated)
- Included both temporary and persistent installation instructions for Bash, Zsh, and Fish
- Updated README Shell Completions section with clearer examples for all three shells

Co-authored-by: sammcj <[email protected]>
Copilot AI changed the title [WIP] Fix confusing documentation around --help command Fix incomplete shell completion help text Jan 17, 2026
Copilot AI requested a review from sammcj January 17, 2026 20:46
@sammcj sammcj marked this pull request as ready for review January 18, 2026 19:21
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes the incomplete and truncated shell completion help text in the ingest completion command. The help output previously had truncated Fish shell instructions and lacked persistent installation guidance.

Changes:

  • Expanded the completion command help text with comprehensive instructions for all three shells (Bash, Zsh, Fish), including both session-only and persistent installation methods
  • Added shell completion examples to README.md for Bash and Fish (previously only Zsh was documented)

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
main.go Expanded the Long help text for the completion command from a truncated single-line format to a comprehensive multi-line format with complete instructions for Bash, Zsh, and Fish shells
README.md Added shell completion examples for all three shells (Bash, Zsh, Fish) instead of only Zsh, with clear session-only vs. persistent installation guidance

@sammcj sammcj merged commit 2772d3b into main Jan 18, 2026
12 checks passed
@sammcj sammcj deleted the copilot/fix-help-documentation-issue branch January 18, 2026 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

fix confusing doco around --help <command>

3 participants