Conversation
There was a problem hiding this comment.
Pull request overview
Updates the README’s CLI reference to explicitly distinguish between persistent installation (direct specify on PATH) and one-time usage (invoking via uvx --from ... specify ...), addressing the confusion raised in issue #318.
Changes:
- Adds a note in the CLI reference explaining that examples assume persistent installation and provides the
uvx --from ... specify ...alternative. - Adds a similar note above the Examples section to reinforce the correct invocation form for one-time usage.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -287,7 +287,7 @@ Community projects that extend, visualize, or build on Spec Kit: | |||
| ## 🔧 Specify CLI Reference | |||
|
|
|||
| The `specify` command supports the following options: | |||
There was a problem hiding this comment.
Markdown collapses single newlines into one paragraph, so this renders as: “The specify command supports the following options: The examples below assume…”, which reads like a run-on sentence due to the colon. Consider inserting a blank line and/or changing the colon to a period so the installation assumption is a separate paragraph.
| The `specify` command supports the following options: | |
| The `specify` command supports the following options. |
mnriem
left a comment
There was a problem hiding this comment.
Please address Copilot feedback
Summary
This pull request clarifies the CLI reference in the README by explaining that the examples assume the persistent installation method was used, which makes the
specifycommand available directly in PATH.It also adds a note above the examples section explaining that users who did not install the CLI persistently should use the
uvx --from ... specify ...form instead.Issue
Addresses confusion described in issue #318.
Files Changed
Impact
These documentation updates help reduce confusion for new users and make the CLI usage instructions easier to follow.