@stdout-design/cli

中文文档
0.9.0发布于 2026/11/02MITTypeScriptES Module构建来源已验证

stdout-design CLI - @stdout-design/core和@stdout-design/dev-server的浅前门

中文使用文档
文档目录12 节
  1. 快速启动
  2. 安装
  3. 命令
  4. 工作室渲染
  5. 工作室开发
  6. 工作室init
  7. 写作模板
  8. 人工智能代理集成
  9. 项目结构
  10. 配置
  11. 平台预设
  12. 许可证

@stdout-design / cli

npm version MIT license TypeScript Bun PRs welcome

故事书的图像-在你的回购和说话,你的代理。

一个CLI,用于将您自己的TSX组件呈现为像素完美的社交和营销图像。实时预览工作室,批量渲染从数据,和MCP服务器的AI代理。

快速启动

# Install
bun add -d @stdout-design/cli

# Scaffold a project
npx @stdout-design/cli init

# Render an image
npx @stdout-design/cli render bento-feature --title "Hello" --out hello.png

# Or open the live studio
npx @stdout-design/cli dev

安装

bun add -d @stdout-design/cli

或在全球范围内:

bun add -g @stdout-design/cli

先决条件: Node.js 22.22+, Bun 1.2+。

命令

命令描述
studio init搭建一个新的工作室项目
studio dev启动实时预览工作室
studio render <template>呈现单个模板或批处理
studio cache stats显示缓存统计信息
studio cache clean清除渲染缓存
studio lint检查模板的兼容性

运行命令 npx @stdout-design/cli <command>,或使用 bun add -g @stdout-design/cli 使用 studio <command> 直接。

工作室渲染

studio render <template> [options]
选项描述
--key value将props传递给模板
--data file.csv从CSV或JSON批量呈现
--preset name输出预设(默认:og)
--locale langi18n的区域设置
--out-dir path输出目录(默认:./out/)
--out file.png单个输出文件

工作室开发

启动一个开发服务器 localhost:3000 :

  • 当模板改变时热重新加载
  • 自动生成的支柱面板
  • 并排预览跨预设
  • 导出模板为PNG格式

工作室init

为一个新的工作室项目搭建脚手架:

  • 打印稿配置
  • 入门的示例模板
  • 用于批量呈现的示例数据文件
  • i18n的区域设置文件

写作模板

模板是一个带有类型化道具的TSX组件:

type Props = {
  title: string;
  stat: string;
};

export default function MilestoneCard({ title, stat }: Props) {
  return (
    <div className="rounded-2xl bg-black p-8 text-white">
      <h1 className="text-4xl font-bold">{title}</h1>
      <p className="mt-2 text-lg">{stat}</p>
    </div>
  );
}

把它扔进去 templates/ 它是可以立即渲染的。

人工智能代理集成

添加到代理的MCP配置中:

{
  "mcpServers": {
    "stdout-design": {
      "command": "npx",
      "args": ["-y", "@stdout-design/cli", "mcp"]
    }
  }
}

可用的工具: list_templates, render, render_batch, list_presets

项目结构

my-project/
├── studio.config.ts      template registry, presets, locales
├── templates/            your TSX components
├── data/                 CSV/JSON for batch renders
├── locales/              translation files
└── out/                  rendered assets (gitignored)

配置

export default {
  templates: "./templates",
  presets: [
    { name: "og", width: 1200, height: 630 },
    { name: "instagram", width: 1080, height: 1080 },
  ],
  locales: ["en", "ar"],
  outDir: "./out",
};

平台预设

预设大小使用
噩1200×630打开图表/社交卡
x-card1200×675X (Twitter)卡
linkedin1200×627LinkedIn链接预览
instagram1080×1080Instagram上的帖子
instagram-story1080×1920Instagram的故事
应用商店1290×2796App Store截图
playstore1080×1920Play Store截图

许可证

麻省理工学院

版本与发布记录

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

版本发布日期距今
0.9.0latest2026/11/02今天
0.8.02026/11/021 天前
0.7.12026/11/021 天前
0.7.02026/10/258 天前
0.6.02026/10/259 天前
0.5.02026/10/259 天前

关于 @stdout-design/cli 的常见问题

@stdout-design/cli 是什么?

stdout-design CLI - @stdout-design/core和@stdout-design/dev-server的浅前门

如何安装 @stdout-design/cli?

在项目目录运行 npm install @stdout-design/cli,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:zod(^4.4.3)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 studio,可以用 npx studio 直接运行。

@stdout-design/cli 支持 TypeScript 吗?

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

@stdout-design/cli 支持 ESM 还是 CommonJS?

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

@stdout-design/cli 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@stdout-design/cli 可以商用吗?

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

@stdout-design/cli 还在维护吗?

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