docs: document --session-read-only flag for TUI read-only mode#3028
Open
aheritier wants to merge 1 commit into
Open
docs: document --session-read-only flag for TUI read-only mode#3028aheritier wants to merge 1 commit into
aheritier wants to merge 1 commit into
Conversation
Add --session-read-only to the CLI reference flags table and add usage examples in both the CLI reference and TUI feature docs. Closes #3026
docker-agent
reviewed
Jun 9, 2026
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟢 APPROVE
This documentation PR accurately describes the --session-read-only flag behavior. The changes are factually correct, consistent with the existing documentation style, and the example commands are valid.
Summary of changes reviewed:
docs/features/cli/index.md: New--session-read-onlyflag row added to the flags table; new example command added to the Examples blockdocs/features/tui/index.md: New commented example added to the "Launching the TUI" code block
No issues found in the changed code.
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
2 participants
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.
Documentation updates
This PR documents the
--session-read-onlyflag introduced by #3026.Changes
9092b7d8--session-read-onlyto CLI reference flags table; add usage examples in CLI and TUI docsDetails
docs/features/cli/index.md— Added--session-read-onlyrow to thedocker agent runflags table (after--session-db), and added a combined--session -1 --session-read-onlyexample to the Examples block.docs/features/tui/index.md— Added a commented example to the "Launching the TUI" code block showing how to open a past session in read-only mode.Behavior documented
/exit,/compact) still work in read-only mode--exec(returns an error)--sessionto review past conversations without accidentally sending new messagesPRs reviewed and found up to date