@happyvertical/smrt-planner

中文文档
0.62.1发布于 2026/11/17MITTypeScriptES Module近 30 天下载 1.4万

Smrt规划器作为可挂载的斯维尔特组件,带有打出的命令集并计划快照.

中文使用文档
文档目录8 节
  1. 运行它
  2. 用这个
  3. 安装软件包
  4. 目录是如何生成的
  5. 脚本
  6. 许可证
  7. 本地主机背景和导出动作
  8. 外部助理在同一个直播应用程序上

规划员

@happyvertical/smrt-planner 生活状况 smrt 单体 时间 packages/planner 和众生的锁在一起 @happyvertical/smrt-* 软件包. (它曾经生活在 happyvertical/smrt-planner,单行0.1.x 仓库存档. )

静态演示 s-r-t添加食谱 (客户、销售、购买.)或整个软件包和应用程序模拟器围绕它们组装:a 带有导航的 shell, 列表视图和创建/ 编辑每个带有样本的模型 数据,以及一个简单的语言帮助页面,每个食谱遵循应用的选项, 包含一个已倒塌的"连接其他工具"部分,列出 REST 路线, MCP cLI命令从每个模型的装饰器生成 s-m-r-t.

这是一个纯粹的静态网站(SvelteKit +) adapter-static) (中文(简体) ). 没什么 安装或存储在服务器上; 样本数据存在于内存中并重置在 重新装入。 该布局来自峡谷起步器, smrt 启动,减去一切 服务器侧 .

运行它

从 smrt 检查出 (Node packageManager) (中文(简体) ). 计划员的目录来自工作空间 所建的明细表,所以要先建一个工作空间:

pnpm install
pnpm turbo run build --filter=@happyvertical/smrt-planner...
pnpm --filter @happyvertical/smrt-planner dev    # http://localhost:5173

该建筑将静态网站写入 ./build (可从任何静态主机中保存, 或者说 pnpm --filter @happyvertical/smrt-planner preview并复制到 ./app 给包裹.

在子路径( 例如 GitHub Pages) 下主机 ? 以 BASE_PATH=/smrt-planner pnpm build。 。 。 .

用这个

  1. 在规划者页面上,添加食谱:小单位如客户,供应商, 销售(需要客户)和采购(需要供应商)。 添加一个 这需要什么? 整套目录仍然在"All 包裹".
  2. 一个食谱打开了从模型自身参数中构建的选项表: 打开或关闭字段(需要保留),设置标签,帮助文本, 默认值和顺序,以及狭义的 REST, MCP和CLI 曝光. 保存写入 外地政策 @happyvertical/smrt-fields 形状,用于内存 现在.
  3. 左向导航每个食谱都生长一个组及其条目(Customers, 销售订单,.)。 打开一个以浏览样本行并创建、编辑或 删除它们。 生成的视图和每个食谱的帮助页面(概览, 任务和字段词汇表) 词汇项和任何关于它的任务步骤都消失了. 钱字段作为整数小单位(cents)存储.
  4. 食谱和选项在 URL 中存在(?r=commerce.sales,...&o=...; 复制该词 分享模拟.

时间短? 这个 烹饪手册 选项卡(首次访问的土地) 一个面包店,一个机械师,一个焊接工和一个瑜伽工作室的起点:, 读取其添加的内容(删除、菜单、违约付款条件、货币和税收),以及 用于替换您的食谱和菜单。 你的记录留下.

助理在您的设备上运行一个小模型。 结尾的聊天图标 一旦一个模型准备好了,头就打开它;在那之前打开AI模型 页 次/ai/),所以第一个点击设定推论,而不是显示空的 闲聊。 左侧栏脚上的三个图标 考虑一下 (语言) 模式), 听着 (语音打字)和 说 (大声读回;每个打开 同一页,您选择并下载。 初访无所建;从此起;"我不..... 需要AI,让我们只是建设"跳过它永远。 活生生的S-m-r-t物体在#4中被跟踪.

生成的记录表使用规划师自己的响应性,开放的形式布局. 生成的记录列表允许您通过选择其标题来排序任何数据列; 再次选择以反转顺序。 排序只更改当前视图 . 左侧栏开始打开, 用户菜单上方的推断控制 它的脚印。 主题标签提供调色板预览,大型外观选择, 一个品牌颜色轮和字体选择. 高级样式 打开专用 CSS编辑器带有语法加亮. CSS适用于计划员随其变化 并保存、出口或进口时随同烹饪本旅行.

安装软件包

主包注册为 npm.happyvertical.com配置范围 一次,然后安装规划器:

pnpm config set @happyvertical:registry https://npm.happyvertical.com/
pnpm add @happyvertical/smrt-planner

同版本在最优等的基础上被镜像为npmjs. 安装 计划员与您的其它 smrt 软件包的版本相同 : 它们释放 一起为一行. Planner 挂载 cookbook驱动的应用程序外壳及其定制控制。 一个主机可以驱动 使用已输入的命令集 :

<script lang="ts">
import { Planner, createPlannerController } from '@happyvertical/smrt-planner';

const controller = createPlannerController();
</script>

<Planner {controller} basePath="/planner" />

Planner 道具,全部可选: controller, (中文(简体) ), basePath (其页数为 服务于, persistence (单位:千美元)'self' 读取并保存此中的烹饪本 浏览器, 'host' 都留给你了, themeControls, (中文(简体) ), defaultTitle (当没有烹饪本名称或 应用库烹饪本;默认为 'Planner', (中文(简体) ), tabs, (中文(简体) ), onready,并:

搭载的编程器是框架的 Cookbook 驱动的应用程序外壳 切换自定义的概览 : 页眉开头的铅笔 编辑菜单和所设置的每个段落页(添加、移动、调整大小、配置) ,并删除部件),每个编辑库中的区域 layout 财务报告和审定财务报表 overviews,因此它与计划的其余部分一起被保存,出口和进口. 这个 metric, (中文(简体) ), records 财务报告和审定财务报表 chart 部件读取浏览器样本数据; 图表将种子行本身分组(通过一个字段,或被桶装的日期字段) )作为运行时报告的站点生成 应用的图表加载器会编译。 它的页是碎片路线(#/s/..., (中文(简体) ), #/m/..., (中文(简体) ), #/packages/...),所以山上不需要主机的任何东西 路由器和每条计划内链接都留在里面.

  • backLink: { href, label } 启动时从计划员处创建链接 其头部,旁边的品牌(一个docs网站的"回到文档").
  • inference 给计划员的助手一个模型 然后交换助手 打开: 头端的聊天图标打开聊天口, 一旦一个模型 和AI模型页面#/ai/之前,一个访客下载 浏览器模型或连接自己的端点。 传出相同的对象 planner.config.json是因为 inference (单位:千美元){ mode, alternatives?, credentialPersistence?, host?, byo? },参见 docs/inference-host.md)或(或) { chat } 和你自己的模特儿一样 参观者带来 它们自己的终点: inference={{ mode: 'byo', alternatives: ['browser'], credentialPersistence: 'memory' }}没有 inference 计划者没有 助手,没有聊天图标.
<Planner
  basePath="/planner"
  backLink={{ href: '/', label: 'Back to documentation' }}
  inference={{ mode: 'byo', credentialPersistence: 'memory' }}
/>

已经拥有主机 AppShell 可挂载 PlannerControls 内在的. 控制是可重复使用的部分; Planner 仍然是完整的外壳. 使用导出 shell 默认启动导航打开, 并推断 控制在页脚中的用户菜单上方。 开始隐藏底板 .

<script lang="ts">
  import { AppShell } from '@happyvertical/smrt-svelte/app';
  import {
    PLANNER_SHELL_EDGE_TOGGLES,
    PLANNER_SHELL_PANEL_DEFAULTS,
    PlannerControls,
  } from '@happyvertical/smrt-planner';
</script>

<AppShell
  edgeToggles={PLANNER_SHELL_EDGE_TOGGLES}
  config={PLANNER_SHELL_PANEL_DEFAULTS}
  layoutEditing
>
  <PlannerControls layout="shell" persistence="host" />
</AppShell>
import { commandTools, createPlannerController } from '@happyvertical/smrt-planner/commands';

const controller = createPlannerController();
const result = controller.run({
  name: 'add_recipes',
  input: { ids: ['commerce.sales'] },
});
// { ok: true, snapshot, receipt } | { ok: false, error: { code, message } }
controller.subscribe((snapshot) => render(snapshot));

commandTools 每个命令为 { name, description, inputSchema }通过它 直接到 LLM 或 MCP 服务器作为工具定义 . controller.snapshot() 是一个紧凑的只读计划(几个 KB),适合模型提示。 图标 : add_recipes, (中文(简体) ), remove_recipes, (中文(简体) ), add_features, (中文(简体) ), remove_features, (中文(简体) ), add_cookbook, (中文(简体) ), remove_cookbook, (中文(简体) ), apply_cookbook, (中文(简体) ), import_cookbook, (中文(简体) ), set_settings, (中文(简体) ), set_policy, (中文(简体) ), set_theme, (中文(简体) ), reset_theme, (中文(简体) ), rename_section, (中文(简体) ), rename_item, (中文(简体) ), hide, (中文(简体) ), show, (中文(简体) ), focus, (中文(简体) ), export_cookbook, (中文(简体) ), undo。 。 。 .

@happyvertical/smrt-planner 财务报告和审定财务报表 @happyvertical/smrt-planner/commands 是斯维尔特源头和JSON, 故通过维特或其他斯维尔特编集器来消耗它们。 一个平地节点 服务器用途 @happyvertical/smrt-planner/core 相反的,(命令的计谋,) 助手的提示, 响应验证, 库目录) 并可以服务预建的应用程序 @happyvertical/smrt-planner/app; 见 docs/inference-host.md。 。 。 .

目录是如何生成的

src/lib/catalog/catalog.json 是应用程序唯一读取的东西。 没错 由 pnpm build 从未犯过罪,从同一个工作空间 发布发布,所以发布的计划员总是准确描述软件包 发布在它旁边:

pnpm --filter @happyvertical/smrt-planner catalog:generate

剧本( E)scripts/generate-catalog.ts:

  1. 阅读每个公众 @happyvertical/smrt-* 工作空间中的软件包 出口 ./manifest.json从它的表率和 smrt-knowledge.json 旁边 每一个包都是依赖性的 即计划者,故涡轮在先建造了它。一个已公布而未建成的明信片 而不是默默地缩小目录。 软件包 没有明显的导出(cli、svelte、ui、.)或没有型号 跳过.
  2. 将基础设施包丢入 src/lib/catalog/generate/exclusions.ts (核心,租赁,工作,提示, 单子是唯一手工保存的部分 每个条目都说明原因. 宣布食谱停留的上市套件(smrt-chat 带来 助手们, smrt-fields 窗体定制:一个食谱是一个特征.
  3. 每个包写:描述、模型、每个模型的字段和类型、 生成了 REST 路由、 MCP 工具和 CLI 命令(来自此知识) 艺术品 surfaces(a) 公共方法,以及可调用人工智能的方法(有MCP) 工具),它用表面,提供者(机密)宣布的食谱 只命名),运行时间,演示种子和浏览器-demo模式(demo,加上 软件包 browser 能力; smrt#3708/#3709),和依赖性( 清单 smrtDependencies 外加型号的外键和交叉包装 引用,仅限于目录包).

输出经过排序,没有时间戳或检出路径,所以是构建 同一棵树在任何地方都是一样的. CATALOG_SOURCE=registry 读取 改为从登记册中公布的软件包(SMRT_PLANNER_REGISTRY 超过它),并且 CATALOG_SOURCE=<path> 比较一下,又一个烂账.

因为图书馆的烹饪书 被校验 对照这个目录 计划员测试,一个打破烹饪本的框架变化(一个字段移出) 一个模型,一个重新命名的配方) 失败了拉出它的要求.

脚本

运行 pnpm --filter @happyvertical/smrt-planner <script>。 。 。 .

脚本对
devVite dev 服务器
build工作空间的 Catalog 和 CLI 版本, 静态应用程序输入 build/ 财务报告和审定财务报表 app/, MCP 部件 app/mcp.html,则 svelte-package 输入 dist/
verify:packpublint 和单雷波的包装出口检查
catalog:generate仅重现目录
typechecksvelte-kit sync, (中文(简体) ), tsc, (中文(简体) ), svelte-check
testVitest, 包括对照工作空间目录验证的每个库目录
test:mcp-browser重建 app/mcp.html 用铬来驱动
test:live-preview-browser在 Chromium 驱动 Dev 服务器的直播预览
test:package -- <tarball>作为孤立的消费者安装和锻炼已经包装的柏油球

节点/DOM测试使用补丁的Happy DOM 21. 安全回归演习 有效的模块,并拒绝先前执行的无效的导入绑定 节点-主机初始化器(GHSA-834v-8h66-3h79).

林特和格式化是单列波的根 pnpm lint。软件包是 由 monrepo 的分批发布与所有其他 smrt 包一起发布(参见 词根 CHANGESETS.md;它从未单独出版.

许可证

MIT: 快乐垂直公司

本地主机背景和导出动作

安装完成 Planner 可以保留较早的对话并添加其 主机的第一个导出动作同时保留本地的 Cookbook 下载 :

<Planner
  inference={{ mode: 'host', host: { endpoint: '/api/planner/chat' } }}
  initialConversation={{
    id: 'stable-handoff-id',
    messages: [{ role: 'user', content: 'I run a repair workshop.' }],
  }}
  cookbookOffers={false}
  exportAction={{
    label: 'Continue with this app',
    run: async ({ export: file, revision, conversation }) => {
      // file is the existing ExportData: fileName, exact text, full cookbook.
      // Store/submit the detached context according to your host's policy.
      await savePlan({ file, revision, conversation });
    },
  }}
  onready={({ nativeAssistant }) => {
    // The same transport the visible native dock uses, not `assistant`.
    nativeAssistant?.subscribeConversation((messages) => remember(messages));
  }}
/>

onready.openAssistant() 使用 shell API 如果无法使用码头/ 模型, 则返回错误 。 它等待斯维尔特 选中此项后, 贝壳注册可以解决; 单独播种永远不会打开码头 .

onready.nativeAssistant 曝光情况 conversation() (一个脱去的全电流) 线程 , subscribeConversation(listener) (即时快照;返回一个) 未订阅, busy, (中文(简体) ), seed({ id, messages }),以及现有的聊天传输 方法。 。 。 遗产 onready.assistant 仍为单独的东道主驱动助理; 无法读取可见的本地码头的信息.

种子只接受纯用户/辅助文本 。 它将完整的输入附加到 一次通知,从来没有执行过, 并返回假的重复的id, 输入错误、飞行中转弯或已经收到原生线 发送。 供应 initialConversation 在打开原生码头之前; 播种 不是取代主动对话的方法。 主机保留原版 在原始信件身份/证明事项时分别记录.

exportLabel="Build" 标签当前本地导出快捷键并显示 文本放在其图标旁。 其无障碍名称、工具提示和 shell slot/菜单标题使用 同样的标签。 输入值或空白值仅保留图标“ Export the app” 默认。 此动作仍然打开本地导出页面; 它不创建 第二次动作或更改下载.

headerNav="labelled" 以 4 替换页眉的厨师帽子和导出图标 边框、 有颜色并带有可见文本的按钮: specs ()#/configure/specs/, (中文(简体) ), 特征(#/configure/recipes/目标 planner-customize),样式 (单位:千美元)#/configure/theme/)和建设(#/configure/export/目标 planner-export, (中文(简体) ), 标签 exportLabel (设定时). 打开的按钮是 aria-current,则 配置标签条只显示其组(Specs; Cookbooks; 食谱; 地物; 主题, 设置; 导出). 他们的口音是主题信息(Specs),成功(Features),三级(Styles) 和警告;通过设置而显示的主旋律 --smrt-header-icon-link-accent 打开 [data-tone='specs'] 诸如来. 光谱标签是 与烹饪本一起保存的自由文本框(specs) (中文(简体) ). 默认, "icons",为 不变.

buildAgentPrompt(cookbook, options?) 从软件包根和 @happyvertical/smrt-planner/core土生土长的建筑工 导出页面和返回 AgentPrompt (单位:千美元)text页:1 bytes, (中文(简体) ), appName, (中文(简体) ), version, (中文(简体) ), delimiter) (中文(简体) ). AgentPromptOptions 接受 fallbackName 财务报告和审定财务报表 version。东道主 调用返回的快速文本应使用 buildAgentPrompt(data.cookbook).text。 。 。 . 核心条目在没有斯维尔特编译器的情况下在平地节点工作.

headerAction={{ label, run }} 在完整的"计划"标题中添加了主按钮. 它使用与下列相同的捕获和繁忙/反应保障: exportAction; 主机可能 将相同的回调通过两个切入点。 导出快捷键和本地 仍可下载. PlannerControls 不使标题动作.

PlannerExportContext 实值 { export: ExportData, revision, conversation }。 。 。 . 导出动作同步抓取文档和线程并拒绝一个 而不是提交部分轮回。 主机回调 内部显示失败; 下载仍然可用 。 对话导出 没有推断历史分解,包括本地工具数据和错误 留言。 推断线仍然只发出最近的转弯 没有服务器 持久、 iframe 桥接、 自动应用程序生成或自定义模型/ recipe 创作是隐含的。 样本记录仍留在烹饪本之外.

cookbookOffers={false} 从本地删除库中的 cookbook 建议 助理的词汇/词汇表; 现有配方/特点构成 可用。 此默认为真, 不删除 Cookbooks 标签 . PlannerControls 还接受 exportAction没有完整的规划者 导出对话框是空的, 因为它没有本地码头 .

外部助理在同一个直播应用程序上

外部主机助理可以驱动 onready.controller 通过专用 MessagePort 不使用,播种,或写 本地助理线程. 主机必须首先按确切的来源验证窗口握手 财务报告和审定财务报表 预期 event.source,然后传输新鲜 MessageChannel 端口 。 这个 库中故意不安装宽窗口消息倾听器.

// Inside the mounted Planner host, after a trusted port transfer:
const binding = bindPlannerCommandPort({
  port,
  controller: handle.controller,
  allowedCommands: ['add_cookbook', 'add_recipes', 'add_features'],
  source: 'external-assistant',
});
// Call binding.invalidate() in the workspace's synchronous onreset callback.
// Call binding.dispose() before replacing/unmounting the mounted Planner.

// On the external assistant side, using the other dedicated port:
const client = connectPlannerCommandPort(otherPort);
const before = await client.snapshot();
// Prepare a hosted model reply from before.snapshot and this assistant's own
// conversation. context() additionally exposes the canonical catalog/tools.
const result = await client.applyReply({
  id: 'stable-request-id',
  generation: before.generation,
  expectedRevision: before.snapshot.revision,
  reply: hostedReply,
});
// Speak/display result.content: it comes from actual command receipts/coaching.

snapshot() 财务报告和审定财务报表 subscribe() 曝光 { generation, snapshot } 从实际 挂载控制器,包括手动编辑. context() 添加软件包 已出版 catalog 财务报告和审定财务报表 tools。 。 。 . execute() 接受一个打出的命令数组; applyReply() 仅接受 { reply, commands?, sampleContext? }后者 验证虚构的样本背景 然后再执行原子舟子批, 然后在成功更改命令后在下一个命令之前安装 调制。 它重复使用本土指令收发和辅导,没有助手线索.

每次突变都需要被观测到的生成和修订. 约束 指定源属性、 命名空间命令 id 、 调试整个 请求,以已更改的输入拒绝 id再利用,并拒绝 stale/重置请求. 允许的命令是明确的(空列表拒绝所有突变). 信封 仅限于32个KiB,16个命令和128个特征请求ID. 每个世代 最多保留256个收据;如果申请被驳回,则永远不要 被悄悄驱逐/重新执行。 重新连接/ 重新确认 能力。 客户端会接到32通电话 超过没有答复的电话 10秒后; 处置拒绝等待呼叫并关闭港口.

invalidate() 只更改连接生成和接收缓存; 它 从不重放应用程序本身。 犬类工作区重置增量 控制器修订和引用主机 onreset 同步, 所以主机绑定 无法接受延迟的重置前回复 。 不自动 重试与较新的修改冲突:先检查当前计划. 一个主机 使用更古老的释放物必须特征化地检测这些出口并报告无法使用 计划者诚实地控制着它的对外对话.

何时 persistence="host",计划控制器不提供浏览器 记住或 默认的遗留恢复: 主机拥有保存当前 Cookbook 。 一个主人 烹饪手册可以提供 projectPersistence键入 犬形外观能力(remembering, (中文(简体) ), recoveryAvailable, (中文(简体) ), setRemember, (中文(简体) ), recover, (中文(简体) ), discardRecovery) (中文(简体) ). 自我持久性使用现有的外观 默认。 重置仍可独立使用。 静态应用的布局供应 其实际峡谷储存能力. 无 inference,本地助理手柄和动作抓取省略本地 对话数据。 经确认的重置仍然退休 任何私人前本地人 语句,因此无法为下一个项目重新恢复其线程.

版本与发布记录

@happyvertical/smrt-planner 共发布 87 个版本,首次发布于 2026/10/11;过去 12 个月发布了 87 个版本。

版本发布日期距今
0.62.1latest2026/11/17今天
0.62.02026/11/17今天
0.61.62026/11/161 天前
0.61.52026/11/161 天前
0.61.42026/11/161 天前
0.61.32026/11/152 天前

关于 @happyvertical/smrt-planner 的常见问题

@happyvertical/smrt-planner 是什么?

Smrt规划器作为可挂载的斯维尔特组件,带有打出的命令集并计划快照.

如何安装 @happyvertical/smrt-planner?

在项目目录运行 npm install @happyvertical/smrt-planner,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:svelte(^5.57.1)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@happyvertical/smrt-planner 支持 TypeScript 吗?

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

@happyvertical/smrt-planner 支持 ESM 还是 CommonJS?

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

@happyvertical/smrt-planner 可以商用吗?

@happyvertical/smrt-planner 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@happyvertical/smrt-planner 的下载量有多少?

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

@happyvertical/smrt-planner 还在维护吗?

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