Use -- separator in sprite exec examples#182
Open
kcmartin wants to merge 1 commit into
Open
Conversation
Contributor
Preview Deployment
Commit: |
Contributor
Lighthouse Results
|
Contributor
E2E Test Results✅ Tests success Ran against: https://pr-182-superfly-sprites-docs.fly.dev |
Collaborator
Author
|
@jbellerb This is a companion PR to your https://github.com/superfly/sprite-env/pull/436 |
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.
Summary
Updates
sprite execexamples in the public docs to use the--separator between sprite's own flags and the command's args.Reported as #164. Examples like
sprite exec ls -lafail withunknown shorthand flag: 'l' in -labecause cobra's flag parser keeps consuming flags after the positional command. The fix issprite exec -- ls -la. This matches the convention adopted upstream (thesprite exec --helpexamples and usage line were updated to show--in the next rc).Changes
quickstart.mdx: everysprite execexample uses--.working-with-sprites.mdx: everysprite execexample uses--. Deprecated-ttyshorthand swapped to--tty -- <cmd>.Tests
Tested all commands against a live Sprite running
rc43version of the CLICloses #164.
Closes #180 (duplicate report, same root cause).