Fix CLI examples in quickstart to use correct exec syntax #113
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
sprite exec passes arguments directly to the command without shell interpretation. Commands using shell operators (&&, |, >, &) need to be wrapped with `bash -c "..."`. Simple commands don't need quotes. Changes: - Add bash -c wrapper for commands with shell operators - Remove unnecessary quotes from simple commands - Fix auth mode reference from `sprite` to `default` Co-Authored-By: Claude Opus 4.5 <[email protected]>
Contributor
CLI Documentation Generator
📚 Commands documented
|
Contributor
Preview Deployment
Commit: |
Contributor
Lighthouse Results
|
Contributor
E2E Test Results✅ Tests success Ran against: https://pr-113-superfly-sprites-docs.fly.dev |
jbellerb
requested changes
Jan 26, 2026
Contributor
jbellerb
left a comment
jbellerb
left a comment
There was a problem hiding this comment.
Looks good. I'm still thinking about if sprite exec should be changed to work like the old examples, but these always work even if that change happens.
src/content/docs/quickstart.mdx
Outdated
| ```bash | ||
| # Start a simple HTTP server on port 8080 | ||
| sprite exec "python -m http.server 8080 &" | ||
| sprite exec bash -c "python -m http.server 8080 &" |
Contributor
There was a problem hiding this comment.
As an example, it makes more sense to keep this in the foreground so the user can stop the server with Ctrl+C. Something like
sprite exec python -m http.server 8080
Collaborator
Author
There was a problem hiding this comment.
Thank you, I addressed your comment, ptal
Reviewer feedback: running in foreground is more intuitive for a quickstart. Split the code block so users get the URL first, then start the server. Co-Authored-By: Claude Opus 4.5 <[email protected]>
jbellerb
approved these changes
Jan 26, 2026
This was referenced Jan 26, 2026
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.
sprite exec passes arguments directly to the command without shell interpretation. Commands using shell operators (&&, |, >, &) need to be wrapped with
bash -c "...". Simple commands don't need quotes.Changes:
spritetodefault