Folra 插件

在 Folra 中安装 .folraplug,或按开发文档编写自己的插件。

开发插件

一个插件从 JSON 清单和 JavaScript 命令开始。可以用 Folra 的 CLI 开发,也可以把开发指南交给 Agent。

处理选区或全文
选择命令接收的文本范围,可以检查文稿、整理选区或生成模板。
原生参数表单
运行插件时,可以通过文本框、下拉菜单和开关设置参数。
返回文本和修改
可以复制或插入插件返回的文本,也可以预览插件提出的修改,再确认是否应用。

工作区工具和编辑器扩展

以下能力需要 Folra 0.1.16 或更高版本,以及插件 API 4。插件脚本在沙盒中运行。

文稿、图片和文字识别
插件可请求读取工作区内的 Markdown 文稿和图片,在本机识别图片里的文字,并提交文件修改方案供你确认。
原生工具和快捷键
插件可以添加原生侧栏或工具窗口,也可以提供快捷键、补全和自定义代码块渲染。
联网请求
插件需声明要访问的 HTTPS 主机。每次发送前,Folra 都会显示目的地和请求内容,由你确认。

解压后按下方步骤安装。选中几行纯文本,从「插件」菜单运行 Plain text tools,即可排序、去重或添加前缀。

用 CLI 开始开发

以下命令以「应用程序」里的 Folra 为例。模板附带可直接运行的命令和测试用例。改完命令后重新测试,再打包到一个新目录。

folra="/Applications/Folra.app/Contents/MacOS/Folra"
"$folra" plugin scaffold ./MyPlugin --api 2 \
  --id com.example.my-plugin --name "My Plugin" --scope selection
"$folra" plugin validate ./MyPlugin
"$folra" plugin test ./MyPlugin
"$folra" plugin pack ./MyPlugin ./MyPlugin.folraplug

安装插件

本地安装需要 Folra 0.1.15 或更高版本。安装前请查看插件要求的最低版本。

  1. 解压下载的 ZIP,或使用自己打包的 .folraplug 文件夹。
  2. 在 Folra 中选择「插件 → 管理插件… → 安装插件…」,选取 .folraplug 文件夹。
  3. 打开 Markdown 文稿,在「插件」菜单中运行插件。