Open
Conversation
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
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.
I opened this PR because I ran into a confusing real-world setup flow that made it hard to tell whether the problem was installation, environment, or model download.
What happened
This was my actual setup path:
@marswave/colisuccessfully with: npm install -g @marswave/coliWhat made this especially confusing is that npm install -g @marswave/coli succeeded, so the natural assumption was that the speech engine setup was already complete.
Only after digging further did it become clear that:
Why this PR
The current docs and UI already contain the necessary pieces, but they do notconnect them clearly enough for a first-time user.
In particular:
This combination makes a successful npm install feel inconsistent with the later runtime error.
Changes
Scope
This PR only changes documentation and user-facing setup/error messaging.
It does not change the transcription pipeline itself.
Note
Low Risk
Low risk: changes are limited to documentation and user-facing status/error messaging plus minor overlay layout tweaks, with no changes to transcription logic or data handling.
Overview
Clarifies in
README.mdandREADME_CN.mdthatnpm install -g @marswave/coliinstalls only the CLI, and that the speech model is downloaded on the first transcription into~/.coli/models/(including updated troubleshooting guidance to retry transcription and clear partial model files).Updates the app’s user messaging to match this flow: shows a brief post-install hint after auto-install, improves incomplete-model/timeout diagnostics to point at
~/.coli/models/and proxy/TUN mode, and adjusts the overlay to wrap and display longer error messages (smaller font, multi-line, wider panel).Written by Cursor Bugbot for commit a5ffa3e. This will update automatically on new commits. Configure here.