Add Usage CLI spec for shell completions and docs#69
Conversation
Add exfig.usage.kdl with full specification of all 19 CLI commands, flags, and arguments. This enables generating shell completions (bash/zsh/fish) and markdown documentation from a single source of truth. - Add usage tool to mise.toml with completions and docs tasks - Generate and attach shell completions as GitHub Release assets - Update CLAUDE.md with completions commands and KDL sync reminder Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly enhances the ExFig CLI's usability and maintainability by introducing a centralized usage specification. This specification now powers the automatic generation of shell completions and comprehensive CLI documentation, ensuring consistency and reducing manual effort. It also integrates these generated assets into the GitHub release process, making them readily available to users. Highlights
Changelog
Ignored Files
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces a significant improvement by adding a exfig.usage.kdl file to serve as a single source of truth for the CLI's structure. This enables auto-generation of shell completions and reference documentation, which greatly enhances developer and user experience. The implementation is well-executed, with corresponding updates to mise.toml for tooling and CLAUDE.md for project documentation. My review focuses on refining the new KDL specification to ensure its accuracy and descriptiveness aligns with the existing command definitions.
Pin usage tool to v2.18.2 in both mise.toml and release workflow, add --fail/pipefail to curl, validate generated completion files are non-empty. Fix version prefix (v2.8.0) and schemas default path in exfig.usage.kdl. Add version sync reminder to CLAUDE.md. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
alexey1312
left a comment
There was a problem hiding this comment.
Thanks for the review! All comments addressed in d09c23c:\n\n- version: Fixed to \"v2.8.0\" to match ExFigCommand.version\n- filter help texts: Updated colors, icons, and images filter args with more descriptive help matching the Swift source (single/multiple/wildcard examples)\n- release.yml: Hardened curl with --fail + pipefail, pinned usage to v2.18.2, added non-empty file validation\n- mise.toml: Pinned usage = \"2.18.2\" (was \"latest\")\n- schemas default: Removed trailing slash from \".exfig/schemas/\"
Match the Swift source help descriptions with single/multiple/wildcard examples for colors, icons, and images filter arguments. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Description
exfig.usage.kdl— full Usage specification covering all 19 CLI commands, flags, arguments, and defaultsusagetool tomise.tomlwithcompletions:bash,completions:zsh,completions:fish, anddocs:cli-referencetasksrelease.ymlCLAUDE.mdwith new completion commands in Quick Reference and a reminder to keepexfig.usage.kdlin sync when modifying CLIAdditional notes
usageCLI at runtime for dynamic completion resolution--experimental-granular-cacheare markedhide=truein the spec