Skip to content

Commit 8a02600

Browse files
committed
Expand A3S Code TUI README
1 parent 91a2b48 commit 8a02600

1 file changed

Lines changed: 61 additions & 4 deletions

File tree

README.md

Lines changed: 61 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,16 @@ a3s code resume
6868
a3s code update
6969
```
7070

71+
Common first-run flow:
72+
73+
```text
74+
/init # inspect the repository and create or update AGENTS.md
75+
/model # pick a configured provider, OS gateway model, or account model
76+
/effort # choose low, medium, high, xhigh, max, or ultracode
77+
/ide # open the workspace tree and terminal editor
78+
/help # open the full command and shortcut guide
79+
```
80+
7181
Install the Rust runtime crate when embedding A3S Code:
7282

7383
```bash
@@ -99,6 +109,39 @@ engineered automation loops.
99109
| Engineered loops | `/loop init`, `/loop run`, `/loop audit`, and `/loop logs` manage durable maker/checker loops under `.a3s/loops` with reports, budgets, state files, and Runtime/RemoteUI evidence when enabled. |
100110
| Operations | `/help` opens the command guide, `/theme` changes syntax themes, `/plugin` and `/reload` refresh skills/plugins, `/top` observes local agent process activity, `/view` reopens the latest RemoteUI ViewLink, and `/update` upgrades and restarts the CLI. |
101111

112+
## TUI Command Catalog
113+
114+
The TUI command palette is intentionally small at the top level. Parameterized
115+
forms live under the asset or context family that owns them.
116+
117+
| Surface | Commands | Capability |
118+
| --- | --- | --- |
119+
| Conversation | `/clear`, `/compact`, `/fork`, `/goal`, `/btw`, `/auto`, `/exit` | Reset or branch the conversation, compact older context, pin a persistent goal, run a background side question, switch approval mode, or leave the TUI. |
120+
| Models and depth | `/model`, `/effort` | Select local ACL models, signed-in account tabs, OS gateway models, and one of the depth profiles from `low` to `ultracode`. |
121+
| Workspace | `/ide`, `/config`, `/output`, `/theme`, `/top`, `! <command>` | Browse and edit files, edit the active config, inspect completed tool calls, change syntax highlighting, view local agent process activity, or run a direct shell turn. |
122+
| Context | `/ctx <query>`, `/ctx <n>`, `/ctx save <n>`, `/sleep` | Search indexed past sessions, attach a transcript window to the next prompt, promote a hit to memory, or consolidate the day's work into durable memory. |
123+
| Memory and knowledge | `/memory`, `/kb`, `/kb add`, `/kb import`, `/kb search`, `/kb vault` | Browse the memory event/entity graph and manage the local personal knowledge vault. |
124+
| OS account | `/login`, `/logout`, `/view` | Sign in to the configured OS account, sign out, and reopen the most recent RemoteUI ViewLink. |
125+
| Agents | `/agent`, `/agent <description>`, `/agent review`, `/agent publish agentic`, `/agent publish application`, `/agent publish tool`, `/agent run`, `/agent deploy`, `/agent open`, `/agent logs`, `/agent status`, `/agent activity`, `/agent list`, `/agent clone`, `/agent off` | Draft, select, review, publish, run, deploy, inspect, clone, and develop agent assets locally or through OS Agent/Function services. |
126+
| MCP servers | `/mcp`, `/mcp <description>`, `/mcp review`, `/mcp publish`, `/mcp deploy`, `/mcp debug`, `/mcp test`, `/mcp open`, `/mcp logs`, `/mcp status`, `/mcp activity`, `/mcp list`, `/mcp clone`, `/mcp off` | Draft and develop MCP server assets, then publish or test them through OS Function as a Service. |
127+
| Skills | `/skill`, `/skill <description>`, `/skill review`, `/skill publish`, `/skill deploy`, `/skill open`, `/skill status`, `/skill activity`, `/skill list`, `/skill clone`, `/skill off` | Draft, review, publish, deploy, inspect, and hot-reload reusable skill assets. |
128+
| Workflows | `/flow`, `/flow <description>`, `/flow review`, `/flow publish`, `/flow run`, `/flow deploy`, `/flow open`, `/flow logs`, `/flow status`, `/flow activity`, `/flow list`, `/flow clone` | Draft local workflow DAGs and manage OS Workflow as a Service assets. This is separate from `DynamicWorkflowRuntime`. |
129+
| OKF packages | `/okf`, `/okf <description>`, `/okf review`, `/okf publish`, `/okf deploy`, `/okf status`, `/okf activity`, `/okf list`, `/okf clone`, `/okf off` | Develop shareable knowledge-package assets and publish them to the OS Knowledge service. |
130+
| Loops | `/loop init`, `/loop run`, `/loop audit`, `/loop logs`, `/loop <task>` | Create durable engineered loops or launch a quick autonomous maker/checker loop. |
131+
| Plugins and updates | `/plugin`, `/reload`, `/update`, `/help` | Toggle discovered skills/plugins, rescan them, upgrade the CLI, and open the full help overlay. |
132+
133+
## Interaction Modes
134+
135+
| Mode | How to enter | Behavior |
136+
| --- | --- | --- |
137+
| Default chat | Type a prompt | The agent plans when useful, streams text/tool events, and asks before gated operations. |
138+
| Plan mode | Shift+Tab until Plan | Read-only discovery tools are approved automatically; mutating tools still ask. |
139+
| Auto mode | `a`, `/auto`, or Shift+Tab until Auto | Tool approvals are granted for the session according to the active permission policy. |
140+
| Direct shell | Start input with `!` | Runs a shell command as a user-directed turn through the same workspace output surface. |
141+
| DeepResearch | Start input with `?` | Uses `DynamicWorkflowRuntime` for evidence fan-out, then synthesizes a cited report and artifacts. |
142+
| Asset development | Enter `/agent`, `/mcp`, `/skill`, or `/okf` | Subsequent prompts are scoped to the selected local asset until the matching `off` command. |
143+
| `ultracode` | Select in `/effort` | Complex turns may use dynamic workflows, local `parallel_task`, signed-in `runtime`, planning, and goal tracking. Trivial turns can remain direct. |
144+
102145
## Startup, Sessions, And Safety
103146

104147
Config discovery checks:
@@ -129,6 +172,13 @@ still author local assets, run local subagents, use memory, and execute
129172
`DynamicWorkflowRuntime`, but OS `runtime`, RemoteUI ViewLinks, OS asset
130173
publishing, and OS service activity panels are unavailable.
131174

175+
The UI keeps long-running work observable. The transcript shows streamed model
176+
text, tool input/output, progress deltas, approvals, RemoteUI view buttons,
177+
dynamic-workflow artifacts, subagent activity, queue entries, and context-fill
178+
warnings. `/output` opens a normalized tool-call log for the current session,
179+
while `/top` shows host-side process activity using the same collector as
180+
`a3s top`.
181+
132182
## Effort Profiles
133183

134184
`/effort` rebuilds the active session with a different depth profile. The design
@@ -221,6 +271,12 @@ Important runtime rules:
221271
- Local workflow history is stored under `.a3s-flow/dynamic-workflows` when the
222272
workspace has a local root; otherwise it uses an in-memory store.
223273

274+
DeepResearch uses the same boundary. A `?` prompt asks the host-controlled
275+
dynamic workflow to gather evidence first. When OS Runtime is available, the
276+
workflow can call `runtime` for remote batch execution; otherwise it schedules a
277+
host-side `parallel_task` step for local subagents. The final synthesis turn
278+
must cite the gathered evidence and link the generated report or RemoteUI view.
279+
224280
## Context And Memory
225281

226282
A3S Code treats context as a managed runtime resource rather than a pile of text
@@ -258,11 +314,12 @@ commands, loops, DeepResearch, and dynamic workflow steps.
258314

259315
| OS mechanism | TUI path |
260316
| --- | --- |
261-
| Agent as a Service | `/agent publish agentic`, `/agent publish application`, `/agent run`, `/agent deploy`, `/agent open`, `/agent logs`, and `/agent status` operate on OS `agent` assets. |
317+
| Agent as a Service | `/agent publish agentic`, `/agent publish application`, `/agent run`, `/agent deploy`, `/agent open`, `/agent logs`, `/agent status`, and `/agent activity` operate on OS `agent` assets and runtime activity. |
262318
| Function as a Service | `/agent publish tool`, `/mcp publish`, `/mcp deploy`, `/mcp debug`, `/mcp test`, `/skill publish`, `/skill deploy`, and the signed-in `runtime` tool use OS function/runtime bindings for tool-like workers. |
263-
| Workflow as a Service | `/flow`, `/flow publish`, `/flow run`, and `/flow deploy` create or update OS workflow assets, sync `.a3s/workflow.runtime-binding.json`, and open designer/run/log/status surfaces. |
264-
| Knowledge service | `/okf publish`, `/okf deploy`, and `/okf status` operate on OS `knowledge` assets. `/kb` remains the local personal knowledge-base browser. |
265-
| RemoteUI | OS progressive responses can return `.view` or `viewUrl`. The TUI stores the latest ViewLink, opens it with the native `a3s-webview` helper when available, and falls back to a browser URL. |
319+
| Workflow as a Service | `/flow`, `/flow publish`, `/flow run`, `/flow deploy`, `/flow open`, `/flow logs`, `/flow status`, and `/flow activity` create or inspect OS workflow assets, sync `.a3s/workflow.runtime-binding.json`, and open designer/run/log/status surfaces. |
320+
| Knowledge service | `/okf publish`, `/okf deploy`, `/okf status`, and `/okf activity` operate on OS `knowledge` assets. `/kb` remains the local personal knowledge-base browser. |
321+
| RemoteUI | OS progressive responses can return `.view` or `viewUrl`. The TUI stores the latest ViewLink, renders an `Open view` action, opens it with the native `a3s-webview` helper when available, and falls back to a browser URL. |
322+
| Runtime tool | After `/login`, the TUI registers `runtime` into the live session. Normal turns and dynamic workflow PTC steps can use it to submit independent subtasks to OS Runtime batch execution. |
266323

267324
## Filesystem-First Agent Model
268325

0 commit comments

Comments
 (0)