Skip to content

docs: add TUI client documentation to ACP clients guide#7950

Merged
blackgirlbytes merged 1 commit intomainfrom
docs/tui-client-documentation
Mar 17, 2026
Merged

docs: add TUI client documentation to ACP clients guide#7950
blackgirlbytes merged 1 commit intomainfrom
docs/tui-client-documentation

Conversation

@blackgirlbytes
Copy link
Contributor

Summary

Documents the new Terminal User Interface (TUI) client for goose that communicates via the Agent Client Protocol (ACP). This provides a text-based interface for developers who prefer terminal-based workflows.

Changes

Added a new TUI Client section to documentation/docs/guides/acp-clients.md covering:

  • Feature overview - Streaming responses, tool call visualization, permission dialogs, keyboard navigation, markdown rendering, message queuing
  • Installation - npm install instructions
  • Running the TUI - Three options (auto-launch, manual server, custom server)
  • Single prompt mode - For scripting use cases
  • Keyboard shortcuts - Complete reference table
  • Permission dialog - How to handle tool permission requests
  • Architecture - Technical details about Ink, ACP SDK, and goose-acp client library

Related

Test Plan

  • Documentation builds successfully (cd documentation && npm run build)
  • New section integrates naturally with existing ACP clients documentation

Document the new Terminal User Interface (TUI) client for goose that
communicates via the Agent Client Protocol (ACP). This provides a
text-based interface for developers who prefer terminal-based workflows.

Documentation includes:
- Feature overview (streaming, tool visualization, permissions)
- Installation and running instructions
- Keyboard shortcuts reference
- Permission dialog usage
- Architecture details (Ink, ACP SDK)

Related to: #7362

Signed-off-by: Rizel Scarlett <rizel@squareup.com>
@blackgirlbytes blackgirlbytes force-pushed the docs/tui-client-documentation branch from de8dda1 to 7a511cd Compare March 17, 2026 05:05
@github-actions
Copy link
Contributor

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://block.github.io/goose/pr-preview/pr-7950/

Built to branch gh-pages at 2026-03-17 05:12 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@blackgirlbytes blackgirlbytes added this pull request to the merge queue Mar 17, 2026
Merged via the queue into main with commit b6cad29 Mar 17, 2026
23 checks passed
@blackgirlbytes blackgirlbytes deleted the docs/tui-client-documentation branch March 17, 2026 06:30
jh-block added a commit that referenced this pull request Mar 17, 2026
* origin/main:
  feat: adversarial agent for preventing leaking of info and more  (#7948)
  Update contributing.md (#7927)
  docs: add credit balance monitoring section (#7952)
  docs: add Cerebras provider to supported providers list (#7953)
  docs: add TUI client documentation to ACP clients guide (#7950)
  fix: removed double dash in pnpm command (#7951)
  docs: polish ACP docs (#7946)
  claude adaptive thinking (#7944)
  feat: new onboarding flow (#7266)
  Add DCO git commit command to AGENTS.md (#7945)
  fix(claude-code): remove incorrect agent_visible filter on user message (#7931)
  No Check do Check (#7942)
  Log 500 errors and also show error for direct download (#7936)
  fix: retry on authentication failure with credential refresh (#7812)
  Remove java/.ai-usage-marker directory (#7925)
  test(acp): add terminal delegation fixtures and fix shell singleton (#7923)
  fix: bump pctx_code_mode to 0.3.0 for iterator type checking fix (#7892)
  feat: persist GooseMode per-session via session DB (#7854)
jh-block added a commit to rabi/goose that referenced this pull request Mar 18, 2026
* main: (32 commits)
  Revert message flush & test (block#7966)
  docs: add Remote Access section with Telegram Gateway documentation (block#7955)
  fix: update webmcp blog post metadata image URL (block#7967)
  fix: clean up OAuth token cache on provider deletion (block#7908)
  fix: hard-coded tool call id in code mode callback (block#7939)
  Fix SSE parsers to accept optional space after data: prefix (block#7929)
  docs: add GOOSE_INPUT_LIMIT to config-files.md (block#7961)
  Add WebMCP for Beginners blog post (block#7957)
  Fix download manager (block#7933)
  Improve the formatting of tool calls, show thinking, treat Reasoning and Thinking as the same thing (sorry Kant) (block#7626)
  don't imply running builds all the time in AGENTS.md (block#7865)
  fix: unregister goosed child process's  listener (block#7956)
  feat: adversarial agent for preventing leaking of info and more  (block#7948)
  Update contributing.md (block#7927)
  docs: add credit balance monitoring section (block#7952)
  docs: add Cerebras provider to supported providers list (block#7953)
  docs: add TUI client documentation to ACP clients guide (block#7950)
  fix: removed double dash in pnpm command (block#7951)
  docs: polish ACP docs (block#7946)
  claude adaptive thinking (block#7944)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants