Conversation
TerminalGravity
left a comment
There was a problem hiding this comment.
Solid troubleshooting guide — covers the main pain points I'd expect from setup. The LanceDB native module section is especially useful since that trips up a lot of people on different architectures.
Two suggestions:
-
Add a Node version compatibility note — preflight requires Node 18+, and a surprising number of people still run 16. Worth a quick "Check your Node version" section at the top since it affects everything downstream.
-
The npx cache section could mention
npx -y preflight-dev-serve@latestto force the latest version — I've seen people get stuck on stale cached versions and not realize-yalone doesn't bust the cache.
Otherwise LGTM — this will save a lot of GitHub issues.
TerminalGravity
left a comment
There was a problem hiding this comment.
Every project needs a TROUBLESHOOTING.md — this'll save a lot of issue triage. 👍
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)
b15d3e3 to
b28d77c
Compare
Adds a comprehensive troubleshooting guide covering:
Also links it from README.md.