Skip to content

Use -- separator in sprite exec examples#182

Open
kcmartin wants to merge 1 commit into
mainfrom
docs/sprite-exec-double-dash
Open

Use -- separator in sprite exec examples#182
kcmartin wants to merge 1 commit into
mainfrom
docs/sprite-exec-double-dash

Conversation

@kcmartin
Copy link
Copy Markdown
Collaborator

@kcmartin kcmartin commented Jun 1, 2026

Summary

Updates sprite exec examples 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 -la fail with unknown shorthand flag: 'l' in -la because cobra's flag parser keeps consuming flags after the positional command. The fix is sprite exec -- ls -la. This matches the convention adopted upstream (the sprite exec --help examples and usage line were updated to show -- in the next rc).

Changes

  • quickstart.mdx: every sprite exec example uses --.
  • working-with-sprites.mdx: every sprite exec example uses --. Deprecated -tty shorthand swapped to --tty -- <cmd>.

Tests

Tested all commands against a live Sprite running rc43 version of the CLI

Closes #164.
Closes #180 (duplicate report, same root cause).

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 1, 2026

Preview Deployment

Name URL
Preview https://pr-182-superfly-sprites-docs.fly.dev

Commit: f99e5ab

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 1, 2026

Lighthouse Results

URL Performance Accessibility Best Practices SEO
/ 🟠 80 🟢 100 🟢 96 🟢 100
/quickstart/ 🟢 91 🟢 100 🟢 100 🟢 100
/working-with-sprites/ 🟢 94 🟢 100 🟢 100 🟢 100

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jun 1, 2026

E2E Test Results

✅ Tests success

Ran against: https://pr-182-superfly-sprites-docs.fly.dev

@kcmartin
Copy link
Copy Markdown
Collaborator Author

kcmartin commented Jun 2, 2026

@jbellerb This is a companion PR to your https://github.com/superfly/sprite-env/pull/436
Let me know if any changes are needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Error following instructions from ubuntu to setup ssh quickstart issue "unknown shorthand flag: -c"

1 participant