docs: document non-TUI input and one-shot --message contract - #698
Open
chrisnestrud wants to merge 1 commit into
Open
chrisnestrud wants to merge 1 commit into
chrisnestrud wants to merge 1 commit into
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
Record the input contract that non-TUI mode now guarantees:
- --message / --message-file are one-shot; there is no follow-up answer path
in that mode, so a question-ending instruction cannot be answered. Multi-turn
runs use interactive mode instead.
- In interactive mode input comes from the TUI box (tui: true), from stdin with
a re-prompt per turn (tui: false), or from a queue push ({"text": ...} and
{"confirmed": ...}) used by the WebSocket/ACP server and the AgentService
wake path.
- Both the TUI and non-TUI input paths consume the same per-coder queue, so a
headless or server-driven session can answer prompts with no terminal.
Documentation only; no code change. Planned to merge after the non-TUI
queued-input fix so the queue contract it describes is accurate.
This branch has not been deployed
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.
What
Documents the input contract for non-TUI sessions:
the model act, then exits. There is no follow-up prompt, so a question-ending
instruction has nowhere to collect an answer. --yes covers fully
non-interactive runs.
turn (tui: false), or a queue push ({"text": ...}, {"confirmed": ...})
from the WebSocket/ACP server and the AgentService wake path.
server-driven session can answer prompts with no terminal.
Files: cecli/website/docs/config/tui.md, cecli/website/docs/scripting.md.
Sequencing
Depends on #697 (the non-TUI queued-input fix). Merge that first so the
queue contract described here is accurate. Docs only; no code change.