@agentworkforce/persona-kit

中文文档
4.2.1发布于 2026/10/05TypeScriptES Module构建来源已验证近 30 天下载 5.3万

Persona-kit owns the AgentWorkforce persona instantiation lifecycle. See tracking issue #64.

原始使用文档
文档目录5 节
  1. Top-level orchestration API
  2. Persona JSON → running agent (end-to-end)
  3. Plan structure
  4. Piecewise helpers
  5. Pure lower-level helpers

@agentworkforce/persona-kit

Persona-kit owns the AgentWorkforce persona instantiation lifecycle. See tracking issue #64.

Top-level orchestration API

The package exposes a two-phase API: a pure plan builder that composes a persona's runtime data into a single inspectable value, and a side-effecting executor that runs the plan and returns a handle that reverses every side effect.

Persona JSON → running agent (end-to-end)

import {
  buildPersonaSpawnPlan,
  executePersonaSpawnPlan,
  type ResolvedPersona
} from '@agentworkforce/persona-kit';
import { spawn } from 'node:child_process';

declare const persona: ResolvedPersona; // from loadPersonas() / personaCatalog

// 1. Compose a plan. Pure — no I/O, no subprocesses.
//    PlanOptions: inputValues, envOverrides, processEnv, installRoot.
//    cwd belongs to ExecuteOptions, not the plan builder.
const plan = buildPersonaSpawnPlan(persona, {
  inputValues: { TASK: 'tidy up the README' }
});

// 2. Inspect or stamp the plan if you like — it's JSON-serializable.
console.log(plan.cli, plan.args, plan.env);

// 3. Run the side effects. Returns a handle whose dispose() reverses them.
const handle = await executePersonaSpawnPlan(plan, { cwd: process.cwd() });

try {
  // 4. Spawn the harness at handle.cwd with plan.cli + plan.args + plan.env.
  await new Promise<void>((resolve, reject) => {
    const child = spawn(plan.cli, plan.args, {
      cwd: handle.cwd,
      env: plan.env,
      stdio: 'inherit'
    });
    child.on('error', reject);
    child.on('close', () => resolve());
  });
} finally {
  // 5. Tear down: removes installed skills, restores sidecar files,
  //    cleans up materialized config files, releases the mount.
  await handle.dispose();
}

Plan structure

PersonaSpawnPlan carries everything a caller needs:

  • persona — the resolved persona (model, harness, skills, env, …).
  • cli, args, initialPrompt — what to spawn.
  • env — final environment with input bindings + persona env merged in.
  • skills — pure SkillMaterializationPlan produced by materializeSkills.
  • mount, sidecars, configFiles, inputs — resolved pieces ready for the executor.

The plan is JSON-serializable — useful for stamping into launch metadata or sending across a wire (e.g. relay's getPersonaSpawnPlan).

Piecewise helpers

For callers who want their own orchestration:

  • applyPersonaMount(mount, options) — opens an @relayfile/local-mount sandbox when a mount policy is supplied, no-op otherwise. Returns a handle exposing the harness cwd.
  • runSkillInstalls(plan, options) — spawns the install commands produced by buildInstallArtifacts. Aborts on the first non-zero exit and attaches the buffered subprocess output to SkillInstallError.
  • writePersonaSidecars(sidecars, options) — writes CLAUDE.md / AGENTS.md with restore-on-dispose semantics.
  • materializePersonaConfigFiles(configFiles, options) — writes the harness config files (e.g. opencode.json) with restore-on-dispose semantics.

Each helper returns a handle of shape { dispose(): Promise<void> }. executePersonaSpawnPlan composes them in order: mount → skills → sidecars → config files. If any step throws, prior handles are disposed in LIFO order before the original error propagates.

Pure lower-level helpers

buildInteractiveSpec, materializeSkills, parsePersonaFile, resolvePersonaInputs, etc. remain available for advanced callers who want finer control than the plan builder offers.

版本与发布记录

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

版本发布日期距今
4.2.1latest2026/10/051 个月前
4.2.02026/10/021 个月前
4.1.612026/09/301 个月前
4.1.602026/09/301 个月前
4.1.592026/09/181 个月前
4.1.582026/09/151 个月前

关于 @agentworkforce/persona-kit 的常见问题

@agentworkforce/persona-kit 是什么?

Persona-kit owns the AgentWorkforce persona instantiation lifecycle. See tracking issue #64.

如何安装 @agentworkforce/persona-kit?

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

@agentworkforce/persona-kit 支持 TypeScript 吗?

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

@agentworkforce/persona-kit 支持 ESM 还是 CommonJS?

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

@agentworkforce/persona-kit 可以商用吗?

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

@agentworkforce/persona-kit 的下载量有多少?

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

@agentworkforce/persona-kit 还在维护吗?

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