@a5c-ai/agent-mux-core

This README is the canonical package documentation for @a5c-ai/agent-mux-core. Canonical package doc path: packages/agent-mux/core/README.md. The repository reference mirror lives at docs/agent-mux/reference/01-core-types-and-client.md and should match this file for package identity, runtime dependencies, and import guidance.

@a5c-ai/agent-mux-core is the public Node.js core runtime package at packages/agent-mux/core/ for agent-mux. It ships:

the main Node entrypoint with AgentMuxClient, createClient, normalized events, run/session/config/auth/plugin contracts, provider and hook helpers, workspace services, and atomic filesystem helpers
@a5c-ai/agent-mux-core/browser for browser-safe type exports plus classifyTool
@a5c-ai/agent-mux-core/kanban for kanban/project/workspace planning types and helpers
@a5c-ai/agent-mux-core/automation for automation rule, trigger, routing, and execution record types

Install

npm install @a5c-ai/agent-mux-core

Requires Node.js >=20.9.0.

This package is published as ESM. The export map exposes import, require, and default conditions, but they all resolve to the same ESM build. Use import from ESM projects. From CommonJS, load it with await import('@a5c-ai/agent-mux-core') instead of expecting a separate CJS bundle.

Runtime dependencies are part of the package contract:

@a5c-ai/agent-catalog provides the harness image catalog plus host-detection rules and metadata used by invocation and host helpers
@a5c-ai/agent-mux-observability provides the structured logging and telemetry primitives used by the client, auth/session flows, and run-handle implementation

Usage

import {
  createClient,
  resolveProvider,
  resolveRunOptions,
  type AuthMethodDescriptor,
  type PluginInfo,
} from '@a5c-ai/agent-mux-core';

const client = createClient();

import { classifyTool, type AgentEvent } from '@a5c-ai/agent-mux-core/browser';
import { buildKanbanProjectBoard } from '@a5c-ai/agent-mux-core/kanban';
import { type AutomationRule } from '@a5c-ai/agent-mux-core/automation';

The public surface is grouped around:

client/runtime entry points such as AgentMuxClient and createClient
run, auth, hook, provider, and capability contracts such as RunOptions, AuthMethodDescriptor, HookRegistration, and ProviderConfig
plugin contracts such as PluginInfo, PluginListing, and PluginBrowseOptions
workspace, merge, and filesystem helpers such as WorkspaceService, resolveRunOptions, and writeFileAtomic

The supported public import seams are:

@a5c-ai/agent-mux-core
@a5c-ai/agent-mux-core/browser
@a5c-ai/agent-mux-core/kanban
@a5c-ai/agent-mux-core/automation

Release Verification

Use the package-local release checks to confirm the documented export map still matches the packed package surface:

npm run build --workspace=@a5c-ai/agent-mux-core
npm run test --workspace=@a5c-ai/agent-mux-core
npm run verify:release --workspace=@a5c-ai/agent-mux-core
npm pack --json --dry-run --workspace=@a5c-ai/agent-mux-core

Release reviewers should be able to confirm from this README that the package intentionally publishes the root, browser, kanban, and automation subpaths and that all of them remain backed by dist/*.js and dist/*.d.ts artifacts.

JSPM