bub-acp-server 0.0.1__tar.gz

bub_acp_server-0.0.1/PKG-INFO

@@ -0,0 +1,121 @@
+Metadata-Version: 2.3
+Name: bub-acp-server
+Version: 0.0.1
+Summary: Expose Bub as an ACP agent
+Author: Frost Ming
+Author-email: Frost Ming <me@frostming.com>
+Requires-Dist: agent-client-protocol==0.10.1
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+
+# bub-acp-server
+
+Expose Bub as an Agent Client Protocol agent.
+
+## What It Provides
+
+- Bub plugin entry point: `acp-server`
+- CLI command registered on Bub: `bub acp`
+- Standalone console script: `bub-acp-server`
+- ACP agent methods for `initialize`, `session/new`, `session/load`, `session/resume`, `session/list`, `session/close`, and `session/prompt`
+- Streaming ACP `session/update` events from Bub stream events
+- ACP client-backed replacements for Bub's `bash`, `fs.read`, `fs.write`, and `fs.edit` tools while the ACP server is running
+
+## Installation
+
+```bash
+uv pip install "git+https://github.com/bubbuild/bub-contrib.git#subdirectory=packages/bub-acp-server"
+```
+
+Or from a Bub project:
+
+```bash
+bub install bub-acp-server@main
+```
+
+## Usage
+
+Configure an ACP-compatible client to launch one of:
+
+```bash
+bub acp
+```
+
+The previous `bub acp serve` form remains accepted temporarily and prints a deprecation warning. Other positional arguments are rejected.
+
+or:
+
+```bash
+bub-acp-server
+```
+
+The process speaks ACP over stdio. Prompts are sent through Bub's hook pipeline with stream output enabled, so model chunks and tool events can be displayed by the ACP client as they arrive.
+
+At the end of every turn, the agent sends an ACP `usage_update`. Missing token usage is reported as `0`. If the model provider does not report its context-window size, set `BUB_ACP_SERVER_CONTEXT_WINDOW_SIZE`; the default is `128000` tokens.
+
+Bub keeps using its own configuration, tools, skills, and tapes. The ACP client starts the process and displays the session; it does not replace Bub's model setup.
+
+ACP session metadata is stored under Bub home as `acp-sessions.json` so compatible clients can list sessions again after restarting. Keep `BUB_HOME` stable if you want the same ACP thread list across editor launches.
+
+`bub-acp-server` supports both ACP session load and resume. `session/load` restores the matching Bub history through the same ACP streaming path used by live turns. `session/resume` attaches the editor back to the Bub session without replaying history, so later turns keep streaming through Bub's normal hook pipeline.
+
+## Use In Zed
+
+Zed supports external terminal agents through ACP. Custom agents are configured in Zed's `settings.json` under `agent_servers`.
+
+Prerequisites:
+
+- `bub` is installed and available to Zed.
+- `bub-acp-server` is installed in the Bub environment:
+
+```bash
+bub install bub-acp-server@main
+```
+
+Open Zed's settings with the `zed: open settings` command and add a custom agent server:
+
+```json
+{
+  "agent_servers": {
+    "Bub": {
+      "type": "custom",
+      "command": "bub",
+      "args": ["acp"],
+      "env": {}
+    }
+  }
+}
+```
+
+If Zed cannot find `bub`, use the absolute path printed by `command -v bub`:
+
+```json
+{
+  "agent_servers": {
+    "Bub": {
+      "type": "custom",
+      "command": "/absolute/path/to/bub",
+      "args": ["acp"],
+      "env": {}
+    }
+  }
+}
+```
+
+After saving the settings, open Zed's agent panel with `cmd-?` on macOS or `ctrl-?` on Linux/Windows, then start a new thread and select `Bub`.
+
+Useful Zed commands while testing:
+
+- `dev: open acp logs` shows the JSON-RPC traffic between Zed and Bub.
+- `zed: open settings` opens `settings.json`.
+
+Notes:
+
+- Zed launches Bub as a separate ACP process. Bub reads its own local configuration and credentials directly.
+- Use `env` only for settings your Bub installation actually needs.
+- If your Bub configuration is loaded from a project `.env`, use a wrapper command that loads that file before running `bub acp`.
+
+References:
+
+- Zed external agents documentation: https://zed.dev/docs/ai/external-agents
+- Zed ACP client page: https://zed.dev/acp/editor/zed

bub_acp_server-0.0.1/README.md

@@ -0,0 +1,111 @@
+# bub-acp-server
+
+Expose Bub as an Agent Client Protocol agent.
+
+## What It Provides
+
+- Bub plugin entry point: `acp-server`
+- CLI command registered on Bub: `bub acp`
+- Standalone console script: `bub-acp-server`
+- ACP agent methods for `initialize`, `session/new`, `session/load`, `session/resume`, `session/list`, `session/close`, and `session/prompt`
+- Streaming ACP `session/update` events from Bub stream events
+- ACP client-backed replacements for Bub's `bash`, `fs.read`, `fs.write`, and `fs.edit` tools while the ACP server is running
+
+## Installation
+
+```bash
+uv pip install "git+https://github.com/bubbuild/bub-contrib.git#subdirectory=packages/bub-acp-server"
+```
+
+Or from a Bub project:
+
+```bash
+bub install bub-acp-server@main
+```
+
+## Usage
+
+Configure an ACP-compatible client to launch one of:
+
+```bash
+bub acp
+```
+
+The previous `bub acp serve` form remains accepted temporarily and prints a deprecation warning. Other positional arguments are rejected.
+
+or:
+
+```bash
+bub-acp-server
+```
+
+The process speaks ACP over stdio. Prompts are sent through Bub's hook pipeline with stream output enabled, so model chunks and tool events can be displayed by the ACP client as they arrive.
+
+At the end of every turn, the agent sends an ACP `usage_update`. Missing token usage is reported as `0`. If the model provider does not report its context-window size, set `BUB_ACP_SERVER_CONTEXT_WINDOW_SIZE`; the default is `128000` tokens.
+
+Bub keeps using its own configuration, tools, skills, and tapes. The ACP client starts the process and displays the session; it does not replace Bub's model setup.
+
+ACP session metadata is stored under Bub home as `acp-sessions.json` so compatible clients can list sessions again after restarting. Keep `BUB_HOME` stable if you want the same ACP thread list across editor launches.
+
+`bub-acp-server` supports both ACP session load and resume. `session/load` restores the matching Bub history through the same ACP streaming path used by live turns. `session/resume` attaches the editor back to the Bub session without replaying history, so later turns keep streaming through Bub's normal hook pipeline.
+
+## Use In Zed
+
+Zed supports external terminal agents through ACP. Custom agents are configured in Zed's `settings.json` under `agent_servers`.
+
+Prerequisites:
+
+- `bub` is installed and available to Zed.
+- `bub-acp-server` is installed in the Bub environment:
+
+```bash
+bub install bub-acp-server@main
+```
+
+Open Zed's settings with the `zed: open settings` command and add a custom agent server:
+
+```json
+{
+  "agent_servers": {
+    "Bub": {
+      "type": "custom",
+      "command": "bub",
+      "args": ["acp"],
+      "env": {}
+    }
+  }
+}
+```
+
+If Zed cannot find `bub`, use the absolute path printed by `command -v bub`:
+
+```json
+{
+  "agent_servers": {
+    "Bub": {
+      "type": "custom",
+      "command": "/absolute/path/to/bub",
+      "args": ["acp"],
+      "env": {}
+    }
+  }
+}
+```
+
+After saving the settings, open Zed's agent panel with `cmd-?` on macOS or `ctrl-?` on Linux/Windows, then start a new thread and select `Bub`.
+
+Useful Zed commands while testing:
+
+- `dev: open acp logs` shows the JSON-RPC traffic between Zed and Bub.
+- `zed: open settings` opens `settings.json`.
+
+Notes:
+
+- Zed launches Bub as a separate ACP process. Bub reads its own local configuration and credentials directly.
+- Use `env` only for settings your Bub installation actually needs.
+- If your Bub configuration is loaded from a project `.env`, use a wrapper command that loads that file before running `bub acp`.
+
+References:
+
+- Zed external agents documentation: https://zed.dev/docs/ai/external-agents
+- Zed ACP client page: https://zed.dev/acp/editor/zed

bub_acp_server-0.0.1/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "bub-acp-server"
+version = "0.0.1"
+description = "Expose Bub as an ACP agent"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = ["agent-client-protocol==0.10.1"]
+
+[[project.authors]]
+name = "Frost Ming"
+email = "me@frostming.com"
+
+[project.entry-points.bub]
+acp-server = "bub_acp_server.plugin:ACPServerPlugin"
+
+[project.scripts]
+bub-acp-server = "bub_acp_server.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.10.4,<0.11.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.3",
+    "pytest-asyncio>=0.21.0",
+]

bub_acp_server-0.0.1/pyproject.toml.orig

@@ -0,0 +1,28 @@
+[project]
+name = "bub-acp-server"
+version = "0.0.1"
+description = "Expose Bub as an ACP agent"
+readme = "README.md"
+authors = [
+    { name = "Frost Ming", email = "me@frostming.com" }
+]
+requires-python = ">=3.12"
+dependencies = [
+    "agent-client-protocol==0.10.1",
+]
+
+[project.entry-points.bub]
+acp-server = "bub_acp_server.plugin:ACPServerPlugin"
+
+[project.scripts]
+bub-acp-server = "bub_acp_server.cli:main"
+
+[build-system]
+requires = ["uv_build>=0.10.4,<0.11.0"]
+build-backend = "uv_build"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.3",
+    "pytest-asyncio>=0.21.0",
+]

bub_acp_server-0.0.1/src/bub_acp_server/__init__.py

@@ -0,0 +1,8 @@
+"""Expose Bub as an ACP agent."""
+
+from __future__ import annotations
+
+__all__ = ["ACPServerPlugin", "BubACPAgent", "run_acp_agent"]
+
+from bub_acp_server.agent import BubACPAgent, run_acp_agent
+from bub_acp_server.plugin import ACPServerPlugin