Update session docs: remove deprecated -detachable flag #79
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
All TTY sessions are now automatically detachable. Users should use `sprite sessions` to list, attach to, and kill sessions instead of the removed -detachable and -id flags on exec. - Replace `exec -detachable` examples with `exec -tty` - Update commands to use `sprite sessions` subcommand - Document Ctrl+\ as the detach keystroke
kylemclaren
force-pushed
the
update-sessions-docs
branch
from
c3740c1 to
3bd9596
Compare
CLI Documentation Generator
📚 Commands documented
|
Preview Deployment
Commit: |
E2E Test Results❌ Tests failure Ran against: https://pr-79-superfly-sprites-docs.fly.dev |
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
exec -detachableflag withexec -ttyin examplessprite sessionssubcommandCtrl+\as the detach keystrokeThe
-detachableflag was removed fromsprite execbecause all TTY sessions are now automatically detachable. Users should use thesprite sessionscommand to list, attach to, and kill sessions.Changes
Updates to "Working with Sprites" page:
exec -detachable→exec -ttyexec -id <id>→sprite sessions attach <id>exec -id <id> -kill→sprite sessions kill <id>Ctrl+\to detach from sessions