docs: add 'verify it's working' section to quickstart#298
Open
TerminalGravity wants to merge 5 commits intomainfrom
Open
docs: add 'verify it's working' section to quickstart#298TerminalGravity wants to merge 5 commits intomainfrom
TerminalGravity wants to merge 5 commits intomainfrom
Conversation
Adds a ready-to-use CLAUDE.md template that makes Claude Code automatically run preflight_check on prompts. Users can copy it into their project to get preflight working without manual tool calls. Referenced from Quick Start in README and examples/README.
- CLI now responds to --help/-h with usage info, profiles, and links - CLI now responds to --version/-v with package version - Previously, any flag just launched the interactive wizard - Fixed README badge from Node 18+ to Node 20+ (matches engines field)
Adds well-commented example config.yml and triage.yml to examples/.preflight/ so users can copy them into their project root and customize. Every field is documented inline with descriptions of valid values and defaults.
TerminalGravity
commented
Mar 20, 2026
Collaborator
Author
TerminalGravity
left a comment
TerminalGravity
left a comment
There was a problem hiding this comment.
Nice addition — "verify it works" is the step most quickstarts skip and most users need. This will cut down on "I installed it but nothing happened" questions.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a verification step after the Quick Start section so users can confirm preflight is actually connected and working. Shows what to expect when it fires, plus troubleshooting steps if nothing happens.