docs: add BYOCLI guide (docs/byocli.md)#129
docs: add BYOCLI guide (docs/byocli.md)#129BlakeHung wants to merge 7 commits intoopenabdev:mainfrom
Conversation
- Add ollama-acp adapter written in Rust, bridging ACP JSON-RPC to Ollama's OpenAI-compatible chat completions API with SSE streaming - Add Dockerfile.ollama for containerized deployment (pure Rust, no Node.js runtime needed) - Add Ollama preset to config.toml.example - Supports any Ollama model (default: gemma4:26b) - Full ACP compliance: initialize, session/new, session/prompt - Streaming notifications: agent_message_chunk, tool_call, etc.
Adapter moved to: https://github.com/BlakeHung/local-ai-acp This PR now only adds config.toml.example reference.
Add local-ai-acp (https://github.com/BlakeHung/local-ai-acp) to: - Pluggable Agent Backends table in README - Manual config.toml examples with setup instructions - config.toml.example with commented preset local-ai-acp is a standalone Rust binary that bridges any OpenAI-compatible API (Ollama, LocalAI, vLLM, llama.cpp, LM Studio) to ACP. No runtime dependencies.
|
We've been thinking about this more — rather than adding individual third-party adapters to the README, we think the right move is:
This way the README stays focused on officially bundled backends, and community adapters like local-ai-acp have a clear path to plug in without needing to be listed in the main docs. We'll get that guide written up. Once it's in place, would you be open to restructuring this PR to reference the BYOCLI guide instead of adding directly to the README table? |
|
To clarify our thinking on this: The README table is reserved for official/tested backends. Third-party adapters like local-ai-acp fall under BYOCLI — users can plug in anything that speaks ACP over stdio by following the guide. No code changes to openab needed. We'll get |
|
@thepagent I'm happy to restructure this PR to contribute a
I'll revert the README changes and push the new guide shortly. Let me know if there's a preferred structure or anything else you'd like covered in the doc! |
- Add docs/byocli.md covering ACP protocol requirements, config setup, testing guide, and session lifecycle - Include local-ai-acp as reference BYOCLI implementation - Revert README.md and config.toml.example to upstream (no changes) Per maintainer feedback: README stays focused on official backends, community adapters are documented in the BYOCLI guide.
Summary
Add
docs/byocli.md— a guide for bringing your own ACP-compatible CLI to openab.Contents
Changes
docs/byocli.md— new filePer maintainer feedback: README stays focused on official backends, community adapters documented in the BYOCLI guide.