agentirc-cli 9.5.0a2__tar.gz → 9.6.0__tar.gz

{agentirc_cli-9.5.0a2 → agentirc_cli-9.6.0}/CHANGELOG.md

@@ -4,6 +4,54 @@ All notable changes to this project will be documented in this file.
 
 Format follows [Keep a Changelog](https://keepachangelog.com/).
 
+## [9.6.0] - 2026-05-02
+
+Closes [agentculture/agentirc#22](https://github.com/agentculture/agentirc/issues/22) — promote the in-process embedding API. Unblocks [agentculture/culture#308](https://github.com/agentculture/culture/issues/308) Phase A2-Bridge: culture's `culture/bots/virtual_client.py` (231 LOC, near-line-for-line copy of agentirc's internal `VirtualClient`) collapses to a thin wrapper around the public class, and `culture/cli/server.py:_run_server` can construct an `agentirc.ircd.IRCd` directly instead of going through the `agentirc serve` subprocess.
+
+### Added
+
+- **`agentirc.virtual_client.VirtualClient`** is now public, semver-tracked. `from agentirc.virtual_client import VirtualClient` is the canonical import. Class behaviour is unchanged — the file moved from `agentirc/_internal/virtual_client.py` to `agentirc/virtual_client.py` with no edits to the class body.
+- **`agentirc.ircd.IRCd`** is now public, semver-tracked. The locked-in surface is the constructor (`IRCd(config: ServerConfig)`), the lifecycle methods (`await ircd.start()`, `await ircd.stop()`), `await ircd.emit_event(event)`, and the `subscription_registry`, `clients`, `channels`, `config`, and `system_client` attributes. Other attributes on `IRCd` remain implementation detail and may change without a major bump.
+- **Embedding worked example** in `docs/api-stability.md` showing how to construct an `IRCd` in-process, register a `VirtualClient`, and run until shutdown. Includes a member-by-member breakdown of the public `IRCd` surface and the `VirtualClient` constructor / method signatures.
+
+### Deprecated
+
+- **`agentirc._internal.virtual_client.VirtualClient`** still resolves via a transitional re-export module that emits `DeprecationWarning` on import. Removal is scheduled for 10.0.0. All in-tree call sites (`ircd.py`, `server_link.py`, `channel.py`, `skills/rooms.py`) have been retargeted at the public path so the shim never fires under our own tests.
+
+### Notes
+
+- This release is purely additive at the Python level. No protocol changes, no CLI changes, no behaviour changes. The wire surface (the `agentirc.io/bot` CAP, `EVENTSUB`/`EVENTUNSUB`/`EVENT`/`EVENTERR`/`EVENTPUB` verbs, the canonical 5-field envelope) is identical to 9.5.0 and stays byte-locked.
+- Citation manifest updated: `culture-virtual-client` now targets `agentirc/virtual_client.py`. New entry `agentirc-internal-virtual-client-shim` covers the deprecation re-export.
+
+## [9.5.0] - 2026-05-02
+
+Closes [agentculture/agentirc#15](https://github.com/agentculture/agentirc/issues/15) — out-of-process bot extension API. Unblocks [agentculture/culture#308](https://github.com/agentculture/culture/issues/308) Phase A2 (bot rewrite against the public API).
+
+### Added
+
+- **IRCv3 `agentirc.io/bot` capability.** Advertised in `CAP LS` output. When negotiated via `CAP REQ`, gates four behaviours: silent JOIN/PART/QUIT broadcasts (other channel members see nothing), no auto-op on a fresh-channel first-joiner, `+` prefix in NAMES output, `B` flag in WHO output. Channel membership is added normally; events still fire (subscribers see them via `EVENTSUB`).
+- **`EVENTSUB` / `EVENTUNSUB` / `EVENT` / `EVENTERR` IRC verbs** for streaming events to bots out-of-process. `EVENTSUB <sub-id> [type=<glob>] [channel=<name>] [nick=<glob>]`: filters AND-ed; `type` and `nick` accept `fnmatch`-style globs; `channel` accepts an exact name, `*`, or empty (nick-scoped only). Multiple concurrent subscriptions per client are allowed. Wire format: `:server EVENT <sub-id> <type> <channel-or-*> <nick> :<base64-json-envelope>` carrying the canonical 5-field envelope. Per-subscription bounded queue (default 1024); on overflow the server emits `EVENTERR <sub-id> :backpressure-overflow` and drops the subscription (connection stays open). Subscriptions die on client disconnect.
+- **`EVENTPUB` IRC verb** for bots to emit custom-typed events back into the stream. `EVENTPUB <type> <channel-or-*> :<base64-json-data>`. Type validated against `EVENT_TYPE_RE` (dotted lowercase, ≥1 dot — single-segment names like `message` and `topic` are reserved for built-in vocabulary). Server fills `nick` from the bot's connection nick (not spoofable) and `timestamp` from `time.time()` so federation peers see consistent clocks. `_`-prefixed keys are stripped from the payload before emit.
+- New internal module `agentirc._internal.event_subscriptions` with the `Subscription` dataclass and `SubscriptionRegistry`. `IRCd.subscription_registry` exposes the registry; `IRCd.emit_event` dispatches every event through it.
+- `agentirc.protocol.SEVENT` verb constant (added in 9.5.0a2; reaffirmed here).
+
+### Changed
+
+- **`webhook_port` is no longer bound by `IRCd.start()`.** The field stays in `ServerConfig` so culture's `~/.culture/server.yaml` keeps loading unchanged, but `agentirc` no longer instantiates the HTTP listener. Consumers that need webhook→bot dispatch host their own listener (see `docs/deployment.md`). No deprecation warning at runtime — the docs change is sufficient.
+- `Channel.add()` no longer auto-ops bot-CAP clients (real or `VirtualClient`). A bot joining an empty channel stays unprivileged; the next human becomes op.
+- `Channel.get_prefix()` returns `+` for bot-CAP members in NAMES output.
+- `Client._build_who_flags()` adds the `B` flag for bot-CAP members in WHO output (composes with `H` and `@`/`+`).
+- `VirtualClient` gains a class-level `caps = frozenset({"agentirc.io/bot", "message-tags"})` so the in-process system bot is treated identically to a real CAP-bot.
+- `Client._handle_cap` `CAP LS` reply now lists supported caps from a class-level `_SUPPORTED_CAPS` frozenset (centralised; removing a cap is a major bump).
+- `agentirc/_internal/bots/http_listener.py` module docstring notes the no-op stub is scheduled for removal in 9.6.0.
+
+### Notes
+
+- This is the **final slice** of the bot extension API. `9.5.0a1` shipped the public `agentirc.protocol` declarations; `9.5.0a2` switched the federation wire format to the 5-field envelope; this release wires the actual behaviour.
+- **Federation interop unchanged from 9.5.0a2.** 9.4→9.5 federation works (sniff tolerance); 9.5→9.4 emit breaks until peers upgrade.
+- The `agentirc.skill.{Event, EventType}` re-export shim from 9.5.0a1 stays through the 9.x line; removal is scheduled for 10.0.0.
+- The `agentirc/_internal/bots/` synthesize stubs (`bot_manager.py`, `http_listener.py`) stay through the 9.5.x cycle; removal is scheduled for 9.6.0 once Phase A2 confirms no consumer imports them.
+
 ## [9.5.0a2] - 2026-05-02
 
 ### Changed

{agentirc_cli-9.5.0a2 → agentirc_cli-9.6.0}/CLAUDE.md

@@ -2,20 +2,22 @@
 
 This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
 
-## Current state: bootstrap complete (9.4.0 released)
+## Current state: bootstrap closed; bot extension API + in-process embedding API shipped (9.6.0 released)
 
-This repo is the agentirc server-core extraction out of the sibling project [`culture`](https://github.com/agentculture/culture). As of 9.4.0 (tagged at `5590256` and live on PyPI):
+This repo is the agentirc server-core extraction out of the sibling project [`culture`](https://github.com/agentculture/culture). The bootstrap is closed; 9.0.0 through 9.6.0 are live on PyPI. The most recent ship is the in-process embedding API (9.6.0, closed [#22](https://github.com/agentculture/agentirc/issues/22)) — promoting `agentirc.ircd.IRCd` and `agentirc.virtual_client.VirtualClient` to public, semver-tracked status so culture's Phase A2-Bridge can construct an IRCd in-process and host bots inside it without going through the `agentirc serve` subprocess. The previous ship was the out-of-process bot extension API (9.5.0, closed [#15](https://github.com/agentculture/agentirc/issues/15)). The repo currently contains:
 
 - **Server-core** (`agentirc/{ircd,server_link,channel,events,skill,remote_client,…}.py`, `agentirc/skills/{rooms,threads,history,icon}.py`) — vendored from `culture@df50942` via the `cite-don't-copy` pattern (see `[tool.citation]` in `pyproject.toml`).
 - **Client transport** (`agentirc/client.py`) — vendored from `culture/agentirc/client.py` in PR-B2.
 - **Public CLI** (`agentirc/cli.py`) — real verb dispatch extracted from `culture/cli/server.py`. Verbs: `serve` (foreground, no PID; for systemd `Type=simple` and containers), `start`/`stop`/`status` (lifecycle), `restart`, `link` (peer-spec validator), `logs` (cat / tail of `~/.culture/logs/server-<name>.log`), `version`. Since 9.4.0, `serve`/`start`/`restart` overlay CLI flags on `--config` YAML (precedence: CLI > YAML > built-in default).
-- **Public config** (`agentirc/config.py`) — `ServerConfig`, `LinkConfig`, `TelemetryConfig` dataclasses plus the `ServerConfig.from_yaml(path)` classmethod (added 9.4.0). Recognises `server`/`telemetry`/`links`/`webhook_port`/`data_dir`/`system_bots` keys; silently ignores culture-only keys (`supervisor`, `agents`, `buffer_size`, etc.) so the same `~/.culture/server.yaml` can drive both daemons.
-- **Public protocol** (`agentirc/protocol.py`) — verb name constants, numerics, IRCv3 tag names. Wire-format quirks (`ROOMETAEND`, `ROOMETASET` typos, `ERR_NOSUCHCHANNEL` semantic misuse, `STHREAD` verb collapse) preserved verbatim — they need coordinated cross-repo bumps to fix.
-- **Test suite** (PR-B3, 9.3.0; +13 in 9.4.0) — 36 tests vendored from `culture@df50942` (~6.5kloc) plus 13 new agentirc-native tests in `tests/test_config_loader.py`. 328 tests run under `pytest -n auto` in ~28s on default workers. Three telemetry tests (`test_bot_event_dispatch_span`, `test_bot_run_span`, `test_metrics_bots`) and `test_welcome_bot` stay in culture because they depend on the real `BotManager`.
-- **Internal support** (`agentirc/_internal/`) — `aio`, `constants`, `protocol/`, `telemetry/`, `virtual_client`, `pidfile`, `cli_shared/`, `bots/` stubs.
-- **Bootstrap docs** (PR-B4, 9.4.0) — `docs/api-stability.md` (3 public modules + semver contract), `docs/cli.md` (verb table, flag reference, exit codes, YAML/CLI precedence, agentirc-vs-culture diff table), `docs/deployment.md` (on-disk footprint, systemd `Type=simple` example, container deployment, multi-host federation, log rotation, coexistence with culture, backup).
+- **Public config** (`agentirc/config.py`) — `ServerConfig`, `LinkConfig`, `TelemetryConfig` dataclasses plus the `ServerConfig.from_yaml(path)` classmethod (added 9.4.0). Recognises `server`/`telemetry`/`links`/`webhook_port`/`data_dir`/`system_bots`/`event_subscription_queue_max` keys; silently ignores culture-only keys (`supervisor`, `agents`, `buffer_size`, etc.) so the same `~/.culture/server.yaml` can drive both daemons. Since 9.5.0, `webhook_port` is accepted but no longer bound by `IRCd.start()` — the field stays in `ServerConfig` for backward compat with culture's YAML, but consumers needing webhook→bot dispatch host their own listener.
+- **Public protocol** (`agentirc/protocol.py`) — verb name constants, numerics, IRCv3 tag names. Since 9.5.0 also exports the bot extension surface: `Event` dataclass, `EventType` (`StrEnum`), 20 `EVENT_TYPE_*` constants, `EVENTSUB`/`EVENTUNSUB`/`EVENT`/`EVENTERR`/`EVENTPUB` verb constants, `SEVENT` federation verb, and `BOT_CAP = "agentirc.io/bot"`. Wire-format quirks (`ROOMETAEND`, `ROOMETASET` typos, `ERR_NOSUCHCHANNEL` semantic misuse, `STHREAD` verb collapse) preserved verbatim — they need coordinated cross-repo bumps to fix.
+- **Bot extension API (9.5.0)** — IRCv3 `agentirc.io/bot` capability gates four behaviours when negotiated via `CAP REQ`: silent JOIN/PART/QUIT broadcasts, no auto-op on a fresh-channel first-joiner, `+` prefix in NAMES output, `B` flag in WHO output. `EVENTSUB <sub-id> [type=<glob>] [channel=<name>] [nick=<glob>]` opens a streaming subscription; `EVENTPUB <type> <channel-or-*> :<base64-json-data>` emits a custom-typed event back into the stream (server fills `nick` and `timestamp` so federation peers see consistent values). Per-subscription bounded queue (default 1024); on overflow the server emits `EVENTERR <sub-id> :backpressure-overflow` and drops the subscription. Quick reference at [`docs/extension-api.md`](docs/extension-api.md); design spec at [`docs/superpowers/specs/2026-05-01-bot-extension-api-design.md`](docs/superpowers/specs/2026-05-01-bot-extension-api-design.md).
+- **Test suite** — 36 tests vendored from `culture@df50942` (~6.5kloc) plus agentirc-native tests in `tests/test_config_loader.py` and `tests/test_wire_format_envelope.py` (the 9.5.0a2 golden-file lock-in). `pytest -n auto` in ~30s on default workers. Three telemetry tests (`test_bot_event_dispatch_span`, `test_bot_run_span`, `test_metrics_bots`) and `test_welcome_bot` stay in culture because they depend on the real `BotManager`.
+- **In-process embedding API (9.6.0)** — `agentirc.ircd.IRCd` and `agentirc.virtual_client.VirtualClient` promoted to the public surface. The `IRCd` public contract is the constructor (`IRCd(config: ServerConfig)`), `await ircd.start()`/`stop()`, `await ircd.emit_event(event)`, plus the `subscription_registry`/`clients`/`channels`/`config`/`system_client` attributes; everything else on `IRCd` remains implementation detail. `VirtualClient` moved from `agentirc/_internal/virtual_client.py` to `agentirc/virtual_client.py` with no body edits; the legacy import path resolves via a deprecation re-export (removal in 10.0.0). Worked example + member breakdown live in [`docs/api-stability.md`](docs/api-stability.md#embedding-agentirc-in-process). Same wire surface as 9.5.0; no protocol changes.
+- **Internal support** (`agentirc/_internal/`) — `aio`, `constants`, `protocol/`, `telemetry/`, `pidfile`, `cli_shared/`, `bots/` stubs, `event_subscriptions/` (added 9.5.0). The `_internal/virtual_client.py` module remains as a deprecation re-export of the now-public `agentirc.virtual_client.VirtualClient`; emits `DeprecationWarning` on import; scheduled for removal in 10.0.0.
+- **Bootstrap docs** (PR-B4, 9.4.0) — `docs/api-stability.md` (3 public modules + semver contract), `docs/cli.md` (verb table, flag reference, exit codes, YAML/CLI precedence, agentirc-vs-culture diff table), `docs/deployment.md` (on-disk footprint, systemd `Type=simple` example, container deployment, multi-host federation, log rotation, coexistence with culture, backup), and `docs/extension-api.md` (bot-author quick reference, added 9.5.0). Public-facing `README.md` rewritten for issue [#19](https://github.com/agentculture/agentirc/issues/19).
 
-End-to-end verified: `agentirc start --port <p>` boots a real IRCd, TCP NICK/USER handshake returns `001 RPL_WELCOME`, `agentirc stop` shuts cleanly. `agentirc serve --config server.yaml --port 9999` correctly overlays CLI flag on YAML. `pip install agentirc-cli==9.4.0` from real PyPI in a clean venv produces both `agentirc` and `agentirc-cli` binaries; both reach the same `agentirc.cli:main` entry point. Acceptance audit recorded at [`docs/superpowers/specs/2026-05-01-task14-audit.md`](docs/superpowers/specs/2026-05-01-task14-audit.md). Culture-side cutover unblocked via [agentculture/culture#308](https://github.com/agentculture/culture/issues/308).
+End-to-end verified: `agentirc start --port <p>` boots a real IRCd, TCP NICK/USER handshake returns `001 RPL_WELCOME`, `agentirc stop` shuts cleanly. `agentirc serve --config server.yaml --port 9999` correctly overlays CLI flag on YAML. `pip install agentirc-cli==9.5.0` from real PyPI in a clean venv produces both `agentirc` and `agentirc-cli` binaries; both reach the same `agentirc.cli:main` entry point. Acceptance audit for the bootstrap recorded at [`docs/superpowers/specs/2026-05-01-task14-audit.md`](docs/superpowers/specs/2026-05-01-task14-audit.md). Culture-side cutover unblocked via [agentculture/culture#308](https://github.com/agentculture/culture/issues/308).
 
 **Outstanding follow-ups (non-blocking; the bootstrap itself is closed):**
 - **Cross-repo wire-format fixes (Track A)** — [#7](https://github.com/agentculture/agentirc/issues/7) (`ROOMETAEND`/`ROOMETASET` typos), [#8](https://github.com/agentculture/agentirc/issues/8) (`ERR_NOSUCHCHANNEL` overload), [#9](https://github.com/agentculture/agentirc/issues/9) (`STHREAD` verb collapse). Each requires culture-side change first then agentirc bump.
@@ -59,13 +61,15 @@ When migrating tests, the rule is: pure server tests come here, transport tests
 
 ## Public API contract (semver-tracked)
 
-Only three modules are public. Everything else is internal and may be refactored without a major bump.
+Five modules are public. Everything else is internal and may be refactored without a major bump.
 
-| Module | Members |
-|---|---|
-| `agentirc.config` | `ServerConfig`, `LinkConfig`, `TelemetryConfig` |
-| `agentirc.cli` | `main()`, `dispatch(argv) -> int` |
-| `agentirc.protocol` | verb name constants, numeric reply codes, extension tag names |
+| Module | Members | Since |
+|---|---|---|
+| `agentirc.config` | `ServerConfig`, `LinkConfig`, `TelemetryConfig` | 9.0.0 |
+| `agentirc.cli` | `main()`, `dispatch(argv) -> int` | 9.2.0 |
+| `agentirc.protocol` | verb name constants, numeric reply codes, extension tag names; bot extension surface (`Event`, `EventType`, `EVENT_TYPE_*`, `EVENTSUB`/`EVENTUNSUB`/`EVENT`/`EVENTERR`/`EVENTPUB`/`SEVENT` verbs, `BOT_CAP`) | 9.2.0 (extended 9.5.0) |
+| `agentirc.ircd` | `IRCd` (constructor + `start`/`stop`/`emit_event`/`subscription_registry`/`clients`/`channels`/`config`/`system_client`) | 9.6.0 |
+| `agentirc.virtual_client` | `VirtualClient` | 9.6.0 |
 
 `agentirc.cli.dispatch(argv)` is the function `culture`'s `culture server` shim calls — it must accept the exact same flag set, exit codes, and stderr formatting that `culture server` produces today. Do not "improve" CLI ergonomics during the bootstrap; that breaks the transparency contract culture relies on. `dispatch()` returns `int` on successful command dispatch and lets argparse's `SystemExit` propagate on `--help`/`--version`/parse-errors per Python convention; in-process callers (i.e. culture's shim) must catch `SystemExit` themselves or use `subprocess`.
 

agentirc_cli-9.6.0/PKG-INFO

@@ -0,0 +1,321 @@
+Metadata-Version: 2.4
+Name: agentirc-cli
+Version: 9.6.0
+Summary: Agent-friendly IRCd: server core for AI agent meshes
+Project-URL: Homepage, https://github.com/agentculture/agentirc
+Project-URL: Issues, https://github.com/agentculture/agentirc/issues
+Author: Ori Nachum
+License: MIT License
+        
+        Copyright (c) 2026 agentculture
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Keywords: agents,culture,irc,ircd,mesh
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: Chat :: Internet Relay Chat
+Requires-Python: >=3.11
+Requires-Dist: opentelemetry-api>=1.22
+Requires-Dist: opentelemetry-exporter-otlp-proto-grpc>=1.22
+Requires-Dist: opentelemetry-sdk>=1.22
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: bandit; extra == 'dev'
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: citation-cli; extra == 'dev'
+Requires-Dist: flake8; extra == 'dev'
+Requires-Dist: isort; extra == 'dev'
+Requires-Dist: pylint; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-xdist>=3; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# AgentIRC
+
+[![PyPI version](https://img.shields.io/pypi/v/agentirc-cli.svg)](https://pypi.org/project/agentirc-cli/)
+[![Python versions](https://img.shields.io/pypi/pyversions/agentirc-cli.svg)](https://pypi.org/project/agentirc-cli/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
+**Agent-friendly IRCd for AI agent meshes.**
+
+`agentirc` is a standalone IRC runtime for human-and-agent rooms. It speaks
+classic IRC ([RFC 2812](https://datatracker.ietf.org/doc/html/rfc2812))
+plus IRCv3 message-tags, room/thread/tag skill verbs, server-to-server
+federation with trust levels, and an out-of-process bot extension API
+(`agentirc.io/bot` capability + `EVENTSUB`/`EVENTUNSUB`/`EVENTPUB` verbs).
+It ships with a small, semver-tracked Python API (`agentirc.config`,
+`agentirc.cli`, `agentirc.protocol`) so other tools can drive an IRCd as a
+library, and a CLI (`agentirc serve`, `agentirc start`, …) for operators.
+
+It is the runtime/protocol layer extracted from
+[`culture`](https://github.com/agentculture/culture), the AgentCulture
+agent-mesh project. You don't need culture to use it — `pip install
+agentirc-cli` is a complete IRCd.
+
+## Relationship to Culture
+
+`agentirc` is the standalone server-core; `culture` is the agent-orchestration
+layer that wraps it.
+
+| Concern | Lives in |
+|---|---|
+| IRCd, channels, federation, history, telemetry | `agentirc` |
+| Client transport, IRCv3 message-tags | `agentirc` |
+| Public Python API (`agentirc.config`, `agentirc.cli`, `agentirc.protocol`) | `agentirc` |
+| Bot extension API (CAP + `EVENTSUB`/`EVENTPUB`) | `agentirc` |
+| Agent backends (`claude`, `codex`, `copilot`, `acp`) | `culture` |
+| Console, mesh credentials, OS keyring | `culture` |
+| Process supervisor, agent manifest | `culture` |
+
+Server-core code is vendored from culture under the **cite-don't-copy**
+pattern — see `[tool.citation]` in [`pyproject.toml`](pyproject.toml) for the
+provenance ledger. Defaults preserve continuity with culture (config path
+`~/.culture/server.yaml`, log path `~/.culture/logs/server-<name>.log`,
+audit path `~/.culture/audit/`) so existing culture deployments don't have
+to migrate; standalone users override via `--config`.
+
+## Install
+
+From PyPI:
+
+```bash
+pip install agentirc-cli
+```
+
+The package is published as **`agentirc-cli`** on real PyPI; on TestPyPI it is
+dual-published as `agentirc-cli` and `agentirc` (both wheels point at the
+same code). Two console scripts are installed — `agentirc` and
+`agentirc-cli` — both routing to the same `agentirc.cli:main` entry point.
+`python -m agentirc <verb>` works equivalently.
+
+`agentirc-cli` requires Python 3.11+.
+
+## Quickstart
+
+Run an IRCd in the foreground (the recommended path under systemd `Type=simple`
+or a container runtime):
+
+```bash
+agentirc serve --host 0.0.0.0 --port 6667
+```
+
+Or as a managed background daemon:
+
+```bash
+agentirc start --name spark --port 6667
+agentirc status --name spark        # Server 'spark': running (PID N, port 6667)
+agentirc logs --name spark -f       # tail ~/.culture/logs/server-spark.log
+agentirc stop --name spark
+```
+
+A YAML config file overrides the built-in defaults; CLI flags override the
+YAML. The default config path is `~/.culture/server.yaml`:
+
+```yaml
+server:
+  name: spark
+  host: 127.0.0.1
+  port: 6700
+telemetry:
+  enabled: true
+links:
+  - {name: alpha, host: 10.0.0.1, port: 6667, password: secret, trust: full}
+```
+
+```bash
+agentirc serve --config ~/.culture/server.yaml --port 9999  # CLI > YAML
+```
+
+For Python consumers:
+
+```python
+from agentirc.config import ServerConfig
+cfg = ServerConfig.from_yaml("~/.culture/server.yaml")
+```
+
+See [`docs/cli.md`](docs/cli.md) for the full verb reference and
+[`docs/deployment.md`](docs/deployment.md) for systemd, containers, and
+multi-host federation.
+
+## Public API and stability
+
+Three modules form the **public, semver-tracked surface**. Everything else
+under `agentirc.*` is internal and may be refactored — including renamed,
+split, or removed — in any minor or patch release.
+
+| Module | Members |
+|---|---|
+| [`agentirc.config`](docs/api-stability.md#agentircconfig) | `ServerConfig`, `LinkConfig`, `TelemetryConfig`, `ServerConfig.from_yaml(path)` |
+| [`agentirc.cli`](docs/api-stability.md#agentirccli) | `main()`, `dispatch(argv) -> int` |
+| [`agentirc.protocol`](docs/api-stability.md#agentircprotocol) | Verb constants, numeric reply codes, IRCv3/extension tag names, the bot extension surface (`Event`, `EventType`, `EVENT_TYPE_*`, `EVENTSUB`/`EVENTUNSUB`/`EVENT`/`EVENTERR`/`EVENTPUB`/`SEVENT`, `BOT_CAP`) |
+
+`agentirc.cli.dispatch(argv)` is the in-process integration surface — it is
+what culture's `culture server` shim calls today. It returns `int` on
+successful dispatch and lets `argparse`'s `SystemExit` propagate for
+`--help` / `--version` / parse errors per Python convention. See
+[`docs/api-stability.md`](docs/api-stability.md) for the full semver
+contract.
+
+## Runtime features
+
+- **Classic IRC.** `PRIVMSG`, `JOIN`, `PART`, `MODE`, `TOPIC`, `NICK`,
+  `USER`, `QUIT`, `WHO`, `WHOIS`, `LIST`, `NAMES`, `INVITE`, `KICK`,
+  `PING`/`PONG`, `CAP`, `ERROR` — all the verbs an existing IRC client
+  expects.
+- **Skill verbs.** `ROOMCREATE`/`ROOMARCHIVE`/`ROOMMETA` for rooms,
+  `THREAD`/`THREADS`/`THREADSEND`/`THREADCLOSE` for threads, `TAGS` for
+  user tags. Reference: [`docs/api-stability.md#agentircprotocol`](docs/api-stability.md#agentircprotocol).
+- **S2S federation.** Configure peers via repeatable `--link
+  name:host:port:password[:trust]` flags or a `links:` section in YAML.
+  Trust levels: `full` (peer can relay messages and replay history) or
+  `restricted` (peer's S2S messages aren't forwarded further). See
+  [`docs/deployment.md#multi-host-federation`](docs/deployment.md#multi-host-federation).
+- **IRCv3 message-tags + bot CAP.** Standard `message-tags` capability
+  for IRCv3 tag-aware clients; the `agentirc.io/bot` capability marks a
+  TCP client as an out-of-process bot — see the next section.
+- **Telemetry.** OpenTelemetry traces and metrics over OTLP/gRPC, plus
+  per-day audit JSONL at `~/.culture/audit/server-<name>-YYYY-MM-DD.jsonl`
+  (rotates at UTC midnight or 256 MiB). Public observability identifiers
+  preserve the `culture.` prefix verbatim for continuity. Configure under
+  `telemetry:` in YAML.
+- **SQLite-backed history.** Channel history persists to
+  `<data-dir>/history.db` in WAL mode; default `<data-dir>` is
+  `~/.culture/data/`. Replayable on reconnect via `BACKFILL`/`BACKFILLEND`.
+
+## Bot extension API (since 9.5.0)
+
+Out-of-process bots are TCP clients that negotiate the `agentirc.io/bot`
+IRCv3 capability. Once negotiated, the client:
+
+- Joins channels silently (no JOIN/PART/QUIT broadcasts to other members).
+- Never gets auto-op on a newly created channel.
+- Appears in `NAMES` prefixed with `+` and in `WHO` with a `B` flag.
+- May issue `EVENTSUB` to stream events and `EVENTPUB` to emit custom
+  events.
+
+The wire shape:
+
+```text
+EVENTSUB   <sub-id> [type=<glob>] [channel=<name>] [nick=<glob>]
+EVENTUNSUB <sub-id>
+EVENT      <sub-id> <type> <channel-or-*> <nick> :<base64-json-envelope>
+EVENTERR   <sub-id> :<reason>
+EVENTPUB   <type> <channel-or-*> :<base64-json-data>
+```
+
+Filters are AND-ed; `type` and `nick` accept `fnmatch`-style globs.
+Per-subscription bounded queue (default 1024, configurable via
+`event_subscription_queue_max` in YAML); on overflow the server emits
+`EVENTERR <sub-id> :backpressure-overflow` and drops the subscription
+(the connection itself stays open). The `Event` envelope is canonical
+JSON: `{type, channel, nick, data, timestamp}`.
+
+See [`docs/extension-api.md`](docs/extension-api.md) for the full
+bot-author guide (event-type vocabulary, JSON shape, mention/DM
+behavior) and
+[`docs/api-stability.md#bot-extension-surface-shipped-in-950`](docs/api-stability.md#bot-extension-surface-shipped-in-950)
+for the wire contract.
+
+**Operational note.** As of 9.5.0, `agentirc` no longer binds `webhook_port`
+even when set in YAML — the field stays in `ServerConfig` for backward
+compatibility with culture's `~/.culture/server.yaml`, but consumers that
+need webhook→bot dispatch host their own HTTP listener (notably culture).
+The field will be removed in 10.0.0.
+
+## Current state and roadmap
+
+The bootstrap is closed; 9.0.0 through 9.5.0 are released to PyPI. The most
+recent ship is the bot extension API (9.5.0, closes [#15](https://github.com/agentculture/agentirc/issues/15)).
+Outstanding follow-ups are tracked in GitHub issues:
+
+- **Track A — coordinated cross-repo wire-format fixes** (require
+  culture-side change first, then agentirc bump):
+  - [#7](https://github.com/agentculture/agentirc/issues/7) `ROOMETAEND` /
+    `ROOMETASET` typo cleanup.
+  - [#8](https://github.com/agentculture/agentirc/issues/8)
+    `ERR_NOSUCHCHANNEL` (403) semantic misuse.
+  - [#9](https://github.com/agentculture/agentirc/issues/9) `STHREAD` verb
+    collapse split.
+- [#10](https://github.com/agentculture/agentirc/issues/10) — backport the
+  `pr-sonar.sh` + `workflow.sh sonar` wiring upstream to `steward`.
+- [#11](https://github.com/agentculture/agentirc/issues/11) — sweep
+  inline IRC verb / numeric-reply string literals to use
+  `agentirc.protocol.<NAME>` constants. Pure refactor.
+- [#12](https://github.com/agentculture/agentirc/issues/12) — migrate the
+  remaining bot-fixtured tests via subprocess fixture (low-priority;
+  currently in culture).
+
+## Wire-format compatibility
+
+Four known wire-format issues are **preserved verbatim** rather than
+fixed, because correcting them in agentirc alone would silently break
+federation with culture peers running unpatched code: `ROOMETAEND`
+(should be `ROOMMETAEND`), `ROOMETASET` (should be `ROOMMETASET`),
+`ERR_NOSUCHCHANNEL` (403) overloaded for "channel exists already", and
+`STHREAD` collapsing what should be two separate verbs. Each requires a
+coordinated cross-repo bump (Track A above). These constants are
+exported as-is from `agentirc.protocol` so callers don't have to
+hardcode the typos. See
+[`docs/api-stability.md#wire-format-quirks-preserved-verbatim`](docs/api-stability.md#wire-format-quirks-preserved-verbatim).
+
+The 9.5 federation seam (`SEVENT` + IRCv3 `event-data` tag) carries the
+canonical 5-field envelope. 9.5 receivers tolerate ≤9.4 legacy peers
+(asymmetric sniff); 9.5→9.4 emit breaks until peers upgrade. Operators
+can roll one peer at a time and accept that 9.5-emitted events drop on
+still-9.4 peers until those peers upgrade.
+
+## Documentation
+
+- [`docs/api-stability.md`](docs/api-stability.md) — public modules,
+  semver contract, `ServerConfig` / `LinkConfig` / `TelemetryConfig`
+  field reference, verb constants, wire-format quirks.
+- [`docs/cli.md`](docs/cli.md) — verb table, flag reference, exit codes,
+  YAML/CLI precedence, `agentirc`-vs-`culture server` diff table.
+- [`docs/deployment.md`](docs/deployment.md) — on-disk footprint, systemd
+  unit, Dockerfile, multi-host federation, log rotation, coexistence
+  with culture, backup.
+- [`docs/extension-api.md`](docs/extension-api.md) — bot-author quick
+  reference for `agentirc.io/bot` + `EVENTSUB`/`EVENTPUB`.
+- [`docs/superpowers/specs/`](docs/superpowers/specs/) — dated design
+  documents: bootstrap design, agentirc extraction design, bot-extension
+  API design.
+- [`CHANGELOG.md`](CHANGELOG.md) — release notes for every published
+  version.
+
+Upstream: [`agentculture/culture`](https://github.com/agentculture/culture).
+Cutover tracking issue:
+[`agentculture/culture#308`](https://github.com/agentculture/culture/issues/308).
+
+## Contributing
+
+Issues and PRs welcome at
+[`agentculture/agentirc`](https://github.com/agentculture/agentirc).
+Dev setup: `uv venv && uv pip install -e ".[dev]"`, then `pytest -n auto`
+(the suite runs in roughly 30s on default workers).
+
+## License
+
+MIT — see [`LICENSE`](LICENSE).