Skip to content

Improve CLI help and completion discoverability - #2718

Merged
Widthdom merged 1 commit into
mainfrom
fix-issue1694-1422-1702-2013
May 31, 2026
Merged

Improve CLI help and completion discoverability#2718
Widthdom merged 1 commit into
mainfrom
fix-issue1694-1422-1702-2013

Conversation

@Widthdom

Copy link
Copy Markdown
Owner

Summary

  • Split top-level help into brief default help, full --help-all / --help-extended, and flag-only --help-flags.
  • Document validate in CLI help, README, and developer guidance.
  • Show --top beside --limit in query command usage lines.
  • Embed the generating cdidx version in bash, zsh, fish, and PowerShell completion scripts.

Validation

  • dotnet build CodeIndex.sln -c Release -p:UseSharedCompilation=false
  • dotnet test tests/CodeIndex.Tests/CodeIndex.Tests.csproj -c Release -p:UseSharedCompilation=false --filter "FullyQualifiedName~ConsoleUiTests|FullyQualifiedName~ProgramCliTests"
  • dotnet run --project tools/CodeIndex.Changelog -- check

Documentation and Changelog

  • Updated README.md and DEVELOPER_GUIDE.md.
  • Added changelog fragments:
    • changelog.d/unreleased/1422.fixed.md
    • changelog.d/unreleased/1694.docs.md
    • changelog.d/unreleased/1702.changed.md
    • changelog.d/unreleased/2013.fixed.md

Follow-up Candidates

Fixes #1694
Fixes #1422
Fixes #1702
Fixes #2013

@Widthdom
Widthdom force-pushed the fix-issue1694-1422-1702-2013 branch from 6f6347b to 44f45e5 Compare May 31, 2026 03:47
@Widthdom
Widthdom marked this pull request as ready for review May 31, 2026 04:10
@Widthdom
Widthdom merged commit 345b7ea into main May 31, 2026
11 checks passed
@Widthdom
Widthdom deleted the fix-issue1694-1422-1702-2013 branch May 31, 2026 04:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment