Skip to content

Commit f7cdce2

Browse files
claudeclaude
committed
docs: refresh Code README surfaces
1 parent 2e72356 commit f7cdce2

3 files changed

Lines changed: 43 additions & 31 deletions

File tree

‎Cargo.lock‎

Lines changed: 10 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎README.md‎

Lines changed: 33 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -35,49 +35,51 @@ hooks, and budget guard with typed objects instead of raw backend strings.
3535

3636
The surrounding A3S project uses that runtime across these layers:
3737

38-
| Name | What it is | Primary repo |
39-
| --- | --- | --- |
40-
| **A3S Code / `a3s-code`** | Rust core plus Node.js and Python SDKs for embedding coding-agent sessions in products. | <https://github.com/AI45Lab/Code> |
41-
| **`a3s code` TUI** | The interactive terminal coding agent. It is shipped by the `a3s` CLI, drives `a3s-code-core`, and renders the event stream with the `a3s-tui` framework. | <https://github.com/A3S-Lab/Cli> |
42-
| **`a3s-tui`** | Terminal UI framework used by the CLI. It is a UI layer, not the agent runtime. | <https://github.com/A3S-Lab/TUI> |
43-
| **A3S monorepo** | Product docs, submodule pins, release orchestration, and related crates. | <https://github.com/A3S-Lab/a3s> |
38+
| Name | What it is | Primary repo |
39+
| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
40+
| **A3S Code / `a3s-code`** | Rust core plus Node.js and Python SDKs for embedding coding-agent sessions in products. | [https://github.com/AI45Lab/Code](https://github.com/AI45Lab/Code) |
41+
| **`a3s code` TUI** | The interactive terminal coding agent. It is shipped by the`a3s` CLI, drives `a3s-code-core`, and renders the event stream with the `a3s-tui` framework. | [https://github.com/A3S-Lab/Cli](https://github.com/A3S-Lab/Cli) |
42+
| **`a3s-tui`** | Terminal UI framework used by the CLI. It is a UI layer, not the agent runtime. | [https://github.com/A3S-Lab/TUI](https://github.com/A3S-Lab/TUI) |
43+
| **A3S monorepo** | Product docs, submodule pins, release orchestration, and related crates. | [https://github.com/A3S-Lab/a3s](https://github.com/A3S-Lab/a3s) |
4444

4545
Use `a3s code` when you want a ready interactive coding agent in a terminal.
4646
Use the A3S Code SDKs when you are building your own harness, IDE extension,
4747
server worker, workflow runner, or product UI.
4848

49+
![1782885080392](image/README/1782885080392.png)
50+
4951
## Core Surfaces
5052

5153
A3S Code is deliberately split into surfaces so products can adopt the runtime
5254
without inheriting the terminal UX:
5355

54-
| Surface | What you use | What it gives you |
55-
| --- | --- | --- |
56-
| Runtime sessions | Rust core, Node.js SDK, Python SDK | `send`, `run`, `stream`, direct tools, cancellation, persistence, verification, lifecycle cleanup. |
57-
| Filesystem-first agents | `AGENTS.md`, `agent.acl`, `.a3s/agents/`, `.a3s/skills/`, AgentDir | Git-reviewable instructions, model policy, worker roles, reusable skills, directory-scoped tools, and schedules. |
58-
| Terminal app | `a3s code` from the `a3s` CLI | Ready TUI with streamed events, tool activity, approvals, memory/git/file panels, and session controls. |
59-
| Host extension points | Typed stores, workspaces, providers, hooks, MCP/AHP, command registry | Product-specific storage, sandboxing, tools, controls, observability, and slash-command behavior without forking the loop. |
56+
| Surface | What you use | What it gives you |
57+
| ----------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
58+
| Runtime sessions | Rust core, Node.js SDK, Python SDK | `send`, `run`, `stream`, direct tools, cancellation, persistence, verification, lifecycle cleanup. |
59+
| Filesystem-first agents | `AGENTS.md`, `agent.acl`, `.a3s/agents/`, `.a3s/skills/`, AgentDir | Git-reviewable instructions, model policy, worker roles, reusable skills, directory-scoped tools, and schedules. |
60+
| Terminal app | `a3s code` from the `a3s` CLI | Ready TUI with streamed events, tool activity, approvals, memory/git/file panels, and session controls. |
61+
| Host extension points | Typed stores, workspaces, providers, hooks, MCP/AHP, command registry | Product-specific storage, sandboxing, tools, controls, observability, and slash-command behavior without forking the loop. |
6062

6163
## Capability Map
6264

63-
| Area | Current capability |
64-
| --- | --- |
65-
| Agent API | `Agent` and `AgentSession` expose `send`, `run`, `stream`, object-shaped requests, explicit-history calls, attachments, direct tool calls, run state, cancellation, persistence, and lifecycle cleanup. |
66-
| Agent loop | Streaming text/tool events, tool-call repair, bounded parse-error recovery, compaction, planning modes, budget guards, active-tool state, and deterministic direct calls. |
67-
| Config | ACL config files or inline ACL source; provider/model selection; skill and agent directories; storage, search, MCP, and delegation settings. |
68-
| LLM clients | Built-in Anthropic, OpenAI-compatible, and Zhipu-compatible clients, plus `SessionOptions::with_llm_client(...)` for host-supplied clients. |
69-
| Tools | Files, search, shell, git, web fetch/search, batch, structured output, programmatic QuickJS tool calling, skills, MCP tools, and task delegation. |
70-
| Commands | Built-in slash commands and a host command registry for product-specific `/command` handlers; the TUI layers its own terminal commands over the same session path. |
71-
| Filesystem-first | `AGENTS.md`, `.a3s/agents/`, `.a3s/skills/`, AgentDir `instructions.md`, `agent.acl`, `tools/`, and `schedules/` make agent behavior reviewable, diffable, and reusable as files. |
72-
| Context | Project instructions, prompt slots, filesystem context, recent-file/ripgrep providers, memory recall, skills, MCP, and run observations. |
73-
| Safety | Permission policies, human confirmation, workspace path checks, tool timeouts, sandbox handle for `bash`, security providers, prompt boundary injection, and redaction-aware logging paths. |
74-
| Delegation | Built-in worker roles, custom Markdown/YAML agents, `task`, `parallel_task`, automatic delegation controls, and subagent task tracking. |
75-
| Orchestration | Programmable fan-out, pipelines, resumable checkpoints, workflow phases, loop caps, and shared workflow budget ledgers. |
76-
| Serving | `serveAgentDir` / `serve_agent_dir` load AgentDir schedules as full harness turns with stable `schedule:<name>` sessions. |
77-
| Workspaces | Local filesystem by default; typed workspace services for custom hosts; optional S3-compatible backend and HTTP/JSON remote-git backend. |
78-
| Persistence | Memory and file session stores, session IDs, auto-save, run snapshots/events, trace artifacts, memory store integration, loop/workflow checkpoints, and retention caps. |
79-
| Verification | `verifyCommands`, verification presets, structured reports, summaries, run events, artifacts, and trace APIs for replayable evidence. |
80-
| Integration | MCP client/manager, AHP hook integration, lifecycle hooks, lane queue options, OpenTelemetry feature flag, Node SDK, Python SDK, and the `a3s code` TUI. |
65+
| Area | Current capability |
66+
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
67+
| Agent API | `Agent` and `AgentSession` expose `send`, `run`, `stream`, object-shaped requests, explicit-history calls, attachments, direct tool calls, run state, cancellation, persistence, and lifecycle cleanup. |
68+
| Agent loop | Streaming text/tool events, tool-call repair, bounded parse-error recovery, compaction, planning modes, budget guards, active-tool state, and deterministic direct calls. |
69+
| Config | ACL config files or inline ACL source; provider/model selection; skill and agent directories; storage, search, MCP, and delegation settings. |
70+
| LLM clients | Built-in Anthropic, OpenAI-compatible, and Zhipu-compatible clients, plus`SessionOptions::with_llm_client(...)` for host-supplied clients. |
71+
| Tools | Files, search, shell, git, web fetch/search, batch, structured output, programmatic QuickJS tool calling, skills, MCP tools, and task delegation. |
72+
| Commands | Built-in slash commands and a host command registry for product-specific`/command` handlers; the TUI layers its own terminal commands over the same session path. |
73+
| Filesystem-first | `AGENTS.md`, `.a3s/agents/`, `.a3s/skills/`, AgentDir `instructions.md`, `agent.acl`, `tools/`, and `schedules/` make agent behavior reviewable, diffable, and reusable as files. |
74+
| Context | Project instructions, prompt slots, filesystem context, recent-file/ripgrep providers, memory recall, skills, MCP, and run observations. |
75+
| Safety | Permission policies, human confirmation, workspace path checks, tool timeouts, sandbox handle for`bash`, security providers, prompt boundary injection, and redaction-aware logging paths. |
76+
| Delegation | Built-in worker roles, custom Markdown/YAML agents,`task`, `parallel_task`, automatic delegation controls, and subagent task tracking. |
77+
| Orchestration | Programmable fan-out, pipelines, resumable checkpoints, workflow phases, loop caps, and shared workflow budget ledgers. |
78+
| Serving | `serveAgentDir` / `serve_agent_dir` load AgentDir schedules as full harness turns with stable `schedule:<name>` sessions. |
79+
| Workspaces | Local filesystem by default; typed workspace services for custom hosts; optional S3-compatible backend and HTTP/JSON remote-git backend. |
80+
| Persistence | Memory and file session stores, session IDs, auto-save, run snapshots/events, trace artifacts, memory store integration, loop/workflow checkpoints, and retention caps. |
81+
| Verification | `verifyCommands`, verification presets, structured reports, summaries, run events, artifacts, and trace APIs for replayable evidence. |
82+
| Integration | MCP client/manager, AHP hook integration, lifecycle hooks, lane queue options, OpenTelemetry feature flag, Node SDK, Python SDK, and the`a3s code` TUI. |
8183

8284
## Install
8385

@@ -500,4 +502,4 @@ cargo build -p a3s-code-py
500502

501503
## License
502504

503-
MIT
505+
MIT

‎image/README/1782885080392.png‎

111 KB
Loading

0 commit comments

Comments
 (0)