@agent-relay/agent

中文文档
7.1.1发布于 2026/05/25TypeScriptES Module构建来源已验证近 30 天下载 3125

Agent Relay

原始使用文档
文档目录9 节
  1. What it does
  2. Install
  3. Quick start
  4. The handler contract
  5. Policy enforcement
  6. Hosted Agent deployment
  7. Burn (LLM call tagging)
  8. Related
  9. License

Agent Relay

@agent-relay/agent

The proactive agent runtime — one handler, three triggers, one workspace.

npm License

Website: agentrelay.com · Docs: agentrelay.com/docs

What it does

@agent-relay/agent lets a developer ship a proactive agent in under 10 minutes and ~30 lines of code. One agent({ ... }) call, one onEvent handler, and the runtime wires up cron schedules, file watches, and inbox messages into a single normalized stream — with shared workspace + ctx, policy gating, retry, dedup, and tracing.

It is built on @agent-relay/events (Layer 2 — the transport-agnostic event stream) and exposes the workspace-aware Layer 3 surface developers actually want to call.

Install

npm install @agent-relay/agent

Quick start

import { agent } from '@agent-relay/agent';

const handle = agent({
  workspace: 'support',
  schedule: { every: '5m' },
  watch: ['/linear/issues/**'],
  onEvent: async (event, ctx) => {
    switch (event.type) {
      case 'cron.tick':
        await ctx.messages.post({ channel: '#triage', text: 'tick' });
        return;

      case 'relayfile.changed':
        const issue = await event.expand('full');
        await ctx.once(`triage:${event.id}`, async () => {
          // dedup-safe work
        });
        return;
    }
  },
});

// ... later
await handle.stop();

The handler contract

Every handler receives (event, ctx):

  • event — a normalized AgentEvent envelope (lightweight; call event.expand('full') to materialize the resource)
  • ctx — workspace-aware context: ctx.workspace, ctx.agentId, ctx.logger, ctx.signal (AbortSignal), ctx.schedule.{at,every,cancel}, ctx.once(key, fn), ctx.files, ctx.messages

Policy enforcement

agent({
  workspace: 'support',
  policy: { mode: 'approval-required', approvals: ['#triage-leads'] },
  onEvent: async (event, ctx) => {
    // each side-effect is gated through policy
    await ctx.messages.post({ channel: '#triage', text: 'ack' });
  },
});
ModeBehavior
suggestSurface intent to ctx; do not execute
autoExecute immediately (default)
approval-requiredBlock on human approval via approvals channels

Hosted Agent deployment

import { deployAgent } from '@agent-relay/agent';

await deployAgent({
  name: 'support-triage',
  workspace: 'support',
  source: './agent.ts',
  provider: { mode: 'byok' },
});

(See the Proactive Agent Runtime spec §7 for Hosted Agent semantics.)

Burn (LLM call tagging)

LLM calls inside ctx.* are auto-tagged with (workspace, agentId, event.type, event.id) for observability via burn. Wrap any code path explicitly with withBurnTags({...}, fn) if you need to add custom dimensions.

License

Apache-2.0 — see LICENSE.

版本与发布记录

@agent-relay/agent 共发布 27 个版本,首次发布于 2026/05/13;过去 12 个月发布了 27 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
7.1.1latest2026/05/255 个月前
7.1.02026/05/235 个月前
7.0.12026/05/225 个月前
6.3.62026/05/225 个月前
7.0.02026/05/225 个月前
6.3.52026/05/225 个月前

关于 @agent-relay/agent 的常见问题

如何安装 @agent-relay/agent?

在项目目录运行 npm install @agent-relay/agent,或使用 pnpm add / yarn add / bun add。

@agent-relay/agent 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@agent-relay/agent 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@agent-relay/agent 可以商用吗?

@agent-relay/agent 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@agent-relay/agent 的下载量有多少?

根据 npm 官方下载统计,@agent-relay/agent 在 2026/10/05 – 2026/11/03 这 30 天内被下载 3,125 次,日均约 104 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@agent-relay/agent 还在维护吗?

最新版本 7.1.1 发布于 2026/05/25(5 个月前);至今共发布 27 个版本,其中过去 12 个月发布了 27 个;首次发布于 2026/05/13。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。