FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

docs: document non-TUI input and one-shot --message contract by chrisnestrud · Pull Request #698 · cecli-dev/cecli · GitHub

Repository navigation

Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .md  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
15 changes: 15 additions & 0 deletions cecli/website/docs/config/tui.md
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
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,21 @@ The TUI is the default in recent versions of Cecli and on older versions it can
cecli ... --tui
```

## Non-TUI Mode

Pass `--no-tui` (or set `tui: false`) to run the plain terminal interface
instead of the full-screen TUI. In this mode:

- Input is read from stdin and re-prompted after each turn.
- Confirmation prompts are read from the terminal.
- Input and confirmations pushed by an external driver are also honored: the
[WebSocket/ACP server](api.html) and the AgentService wake path push onto the
coder's input queue, so a headless or server-driven session can answer prompts
with no terminal attached.

Both modes consume the same per-coder input queue, so prompt handling is
consistent whether or not the TUI is running.

## Configuration

The TUI can be configured directly in the relevant config.json file or with JSON in the command line arguments:
Expand Down
23 changes: 23 additions & 0 deletions cecli/website/docs/scripting.md
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
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@ for FILE in *.py ; do
done
```

> **Note:** `--message` (`-m`) and `--message-file` (`-f`) are **one-shot**.
> Cecli sends the message, lets the model act on it, then exits. There is no
> follow-up prompt in this mode, so an instruction that ends by asking you a
> question has nowhere to collect your answer. Pass `--yes` for fully
> non-interactive runs, or use one of the multi-turn routes below.

Use `cecli --help` to see all the [command line options](config/options.html), but these are useful for scripting:

```
Expand All @@ -50,6 +56,23 @@ Use `cecli --help` to see all the [command line options](config/options.html), b
[env var: CECLI_COMMIT]
```

### Multi-turn input

Run cecli without `--message` and it stays up for a back-and-forth session. Where
your input comes from depends on the mode:

- **TUI** (`tui: true`, the default): type into the chat input box.
- **Non-TUI** (`--no-tui`, or `tui: false`): input is read from stdin and
re-prompted after every turn. Questions and confirmation prompts from the
agent are answered at the terminal prompt.
- **Programmatic**: an external driver pushes `{"text": ...}` (and
`{"confirmed": ...}` for yes/no confirmations) onto the coder's input queue.
The [WebSocket/ACP server](config/api.html) and the AgentService wake path use
this route.

Both input paths consume the same per-coder queue, so a headless or
server-driven session can answer prompts with no terminal attached.


## Python

Expand Down
Loading

Back | FazBrowse Home | New Git URL