Introduction
Connection for one Agent, coordination for many, and the public entries.
Packages
@rivus/agent-kit connects to one Agent at a time. It is a universal Agent toolkit: it knows each Agent's id and home directory, lists its sessions, and reads their logs into one transcript model with one usage convention. Claude Code, Codex and Grok are today's built-in Agents, along with the others on Supported Agents.
@rivus/agent-kit-collab coordinates many Agents. It adds fenced leases (/lease), a single-instance process lock (/process-lock) and keyed scheduling lanes (/lanes). The package knows no particular Agent. Collab's entries use agent-kit's public platform and follow the same lockstep release.
Files, processes and the environment come from a Platform object that the caller passes in, so the reading code also runs in a browser. ACP is implemented in /acp. /harness installs an application's hooks and skills into these Agents and removes them again, with a ledger of what it wrote.
Status is 0.x. A minor release may contain breaking changes. Both packages share one lockstep release policy, so they ship the same version.
Entries
The source API has 18 entries in @rivus/agent-kit and three in @rivus/agent-kit-collab (21 in total). The tables describe that source API.
| Entry | Main exports | Runs in |
|---|---|---|
@rivus/agent-kit/acp | connectAgent, probeAgent, agentEnv, SessionBindingStore and its Layers | with effect and a platform that spawns |
@rivus/agent-kit/providers | Provider, builtinProviders | anywhere |
@rivus/agent-kit/catalog | isBuiltinCodingAgentId, Result, ok, err, AgentKitError, isAgentKitError | anywhere |
@rivus/agent-kit/cost | createPricing, summarize, priceRecord, Pricing | anywhere, no imports |
@rivus/agent-kit/cost/prices | litellmPrices, litellmPricesVersion: a LiteLLM price snapshot | anywhere, no imports |
@rivus/agent-kit/discovery | detectAgents, versionFromOutput, ProbeRecipe | anywhere, with a platform |
@rivus/agent-kit/harness | Effect: planInstall, applyInstall, verify, uninstall, inventory, doctor, HarnessLive and its ports | anywhere, with effect and a platform |
@rivus/agent-kit/harness/events | readHookEvent, builtinHookDialects, LifecycleEvent | anywhere, no imports |
@rivus/agent-kit/platform | Platform (type only) | anywhere |
@rivus/agent-kit/redact | redact, redactText: hide home path spellings and secret-shaped strings | anywhere, no imports |
@rivus/agent-kit/node | createNodePlatform | Node |
@rivus/agent-kit/platform/effect | PlatformService: the Platform as an Effect service | anywhere, with effect |
@rivus/agent-kit/node/effect | NodePlatformLive: a Layer that provides PlatformService with createNodePlatform() | Node, with effect |
@rivus/agent-kit/sessions | listSessions, sessionAdapterHome, isSessionHead, SessionAdapter | anywhere, with a platform |
@rivus/agent-kit/transcript | loadTranscript, summarizeSession, Transcript, TranscriptEvent | anywhere, with a platform |
@rivus/agent-kit/transcript/usage | scanUsage, isUsageRecord, noCacheInputTokens, UsageRecord | anywhere, with a platform; no imports |
@rivus/agent-kit/testing | createMemoryPlatform, sessionAdapterConformance, hookDialectConformance, probeRecipeConformance | Node |
@rivus/agent-kit/testing/effect | aggregateRepositoryConformance: the conformance cases every aggregate repository passes | anywhere, with effect |
| Entry | Main exports | Kind |
|---|---|---|
@rivus/agent-kit-collab/process-lock | acquireProcessLock, isProcessLockHeld, ProcessLock, ProcessLockPlatform | plain TS |
@rivus/agent-kit-collab/lease | createLeaseManager, LeaseRepository, sqliteLeaseRepository, fileLeaseRepository, memoryLeaseRepository | Effect |
@rivus/agent-kit-collab/lanes | createLanes | Effect |
builtinProviders from /providers exposes each Agent's identity, discovery, install, sessions, usage and acp services when supported. Select a descriptor by id, then check the optional service before use. The ordinary entries share these service objects. Hook commands keep using builtinHookDialects from /harness/events, whose isolated build imports nothing and owns separate hook objects. /catalog retains AgentKitError and isAgentKitError so callers can recognize errors from shell functions.
The Runs in column marks entries that need effect with "with effect". Plain entries do not load that optional peer.
License
MIT. Source: PerfectPan/agent-kit. @rivus/agent-kit-collab is MIT as well.
To contribute, start from CONTRIBUTING.md.