Skip to content

docs: clarify set-mode mode ids are adapter-defined #27

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
z-x-yang wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify set-mode mode ids are adapter-defined #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ acpx codex --file prompt.md # prompt from file
acpx codex --file - "extra context" # explicit stdin + appended args
acpx codex --no-wait 'draft test migration plan' # enqueue without waiting if session is busy
acpx codex cancel # cooperative cancel of in-flight prompt
acpx codex set-mode plan # session/set_mode
acpx codex set-mode auto # session/set_mode (adapter-defined mode id)
acpx codex set approval_policy conservative # session/set_config_option
acpx exec 'summarize this repo' # default agent shortcut (codex)
acpx codex exec 'what does this repo do?' # one-shot, no saved session
Expand Down Expand Up @@ -296,6 +296,7 @@ acpx --agent ./my-custom-acp-server 'do something'
- `--no-wait` submits to that queue and returns immediately.
- `cancel` sends cooperative `session/cancel` to the running queue owner process and returns success when no prompt is running (`nothing to cancel`).
- `set-mode` and `set` route through queue-owner IPC when active, otherwise they reconnect directly to apply `session/set_mode` and `session/set_config_option`.
- `<mode>` values for `set-mode` are adapter-defined; unsupported values are rejected by the adapter (commonly `Invalid params`).
- `exec` is always one-shot and does not reuse saved sessions.
- Session metadata is stored under `~/.acpx/sessions/`.
- Each successful prompt appends lightweight turn history previews (`role`, `timestamp`, `textPreview`) to session metadata.
Expand Down
2 changes: 2 additions & 0 deletions docs/CLI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,8 @@ acpx [global_options] set-mode <mode> [-s <name>] # defaults to codex
Behavior:

- Calls ACP `session/set_mode`.
- `<mode>` values are adapter-defined (not globally standardized across all ACP adapters).
- Unsupported mode ids are rejected by the adapter (often as `Invalid params`).
- Routes through queue-owner IPC when an owner is active.
- Falls back to a direct client reconnect when no owner is running.

Expand Down
3 changes: 2 additions & 1 deletion skills/acpx/SKILL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,14 +131,15 @@ Behavior:

```bash
acpx codex cancel
acpx codex set-mode plan
acpx codex set-mode auto
acpx codex set approval_policy conservative
```

Behavior:

- `cancel`: sends cooperative `session/cancel` through queue-owner IPC.
- `set-mode`: calls ACP `session/set_mode`.
- `set-mode` mode ids are adapter-defined; unsupported values are rejected by the adapter (often `Invalid params`).
- `set`: calls ACP `session/set_config_option`.
- `set-mode`/`set` route through queue-owner IPC when active, otherwise reconnect directly.

Expand Down