docs(zinit): fix bpick pattern, add wait/lucid ices, zcompile#3492
docs(zinit): fix bpick pattern, add wait/lucid ices, zcompile#3492HaleTom wants to merge 4 commits into
Conversation
- Fix bpick to exclude server binary: atuin-*.tar.gz~*server* - Add wait ice for turbo-mode async loading after prompt - Add lucid ice to suppress Loaded message
Fossier: Manual Review Requested
Score BreakdownTotal Score: 52.3/100 | Confidence: 100% | Outcome: REVIEW
|
|
Closes #3491 |
There was a problem hiding this comment.
Pull request overview
Documentation fix for the zinit installation snippet to ensure users install the client (not server) binary and to use turbo-mode loading.
Changes:
- Update
bpickglob to exclude server tarball. - Add
waitandlucidices for asynchronous loading. - Update the explanatory comment accordingly.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Greptile SummaryThis PR updates the zinit installation example for Atuin's GitHub release assets. The main changes are:
Confidence Score: 5/5This looks safe to merge.
Reviews (1): Last reviewed commit: "docs(zinit): fix bpick pattern and add w..." | Re-trigger Greptile |
|
Hi @ellie @BinaryMuse! 👋 This docs PR is ready for review — all CI checks are green and there are no unresolved comments. Summary: Fixes the zinit installation snippet to:
Would appreciate a review when you get a chance. Thanks! |
The zinit installation docs at https://docs.atuin.sh/cli/guide/installation/ have two issues:
1.
bpickpattern matches server binaryThe current pattern
bpick"atuin-*.tar.gz"matches both the client binary (atuin-x86_64-unknown-linux-gnu.tar.gz) and the server binary (atuin-server-x86_64-unknown-linux-gnu.tar.gz). Since GitHub releases returns the server asset first alphabetically, users get the wrong binary:Fix: Use zsh glob exclusion to skip server artifacts:
2. Missing
waitandlucidicesThe current zinit example loads synchronously during
.zshrcprocessing. For a binary plugin that doesn't need to be available until after the prompt,wait(turbo mode) andlucid(suppress "Loaded" message) are recommended:3. Add
zcompilefor faster startupCompiling
init.zshto.zwcwithzcompilegives faster startup times since zsh auto-loads the compiled bytecode:Proposed corrected example