如快开发者文档

Appearance

本页介绍如何用脚手架快速创建一个如快插件，并在本地运行与构建。

准备工作 ​

  • 已安装 如快 v0.9.0+（支持插件运行与新 Worker API）
  • 已安装 Node.js（建议 18+）与包管理器（pnpm/yarn/npm）

创建工程 ​

bash
npx create sofast-extension

交互示例 ​

text
$ npx create sofast-extension

? Project name … my-first-plugin
? Use TypeScript? … yes
? Framework … React / Vue / Empty
? Display title … My First Plugin
? Use Tailwind? … yes

✔ Scaffolded Sofast extension: /path/to/my-first-plugin

Next steps
  1) cd my-first-plugin
  2) pnpm i (or yarn / npm i)
  3) pnpm dev

选项说明 ​

  • 语言：TypeScript（推荐）
  • 框架：React / Vue / Empty（任选）
  • 是否启用 Tailwind：按需

安装依赖并启动 ​

bash
cd <your-plugin>
pnpm i
pnpm dev

构建发布产物 ​

bash
pnpm build

构建结果 ​

  • index.html 与静态资源（UI）
  • package.json（包含顶层 commands 清单）

提示 如果需要在插件中调用宿主能力，请在工程中添加 @sofastapp/api（UI）或 @sofastapp/api/node（No-View）依赖；脚手架默认未内置这些包。

安装到如快 ​

  • 将构建输出目录放置到应用安装目录下的 extensions/<your-plugin>

打开如快后，在命令面板搜索你的命令名（来自 package.json.commands[].title），即可运行。

下一步 ​

  • 编辑 package.json 清单：/guide/manifest
  • 开发 View 命令：/guide/view
  • 开发 No-View 命令：/guide/no-view
  • 打包与安装：/guide/deploy