Skip to content

脚本开发总览

声明脚本的形态、触发方式与参数。盒子负责环境、触发、界面、协作与分发——脚本逻辑之外的部分不需要手写。

不忙脚本盒子是一款 Windows 跨语言脚本管理软件,支持 Python、Node.js、PowerShell、AutoHotkey、BAT、HTML、EXE 七种脚本形态。它负责脚本运行环境、依赖、触发入口与分发。脚本因此装好就能跑、右键就能用、能定时、能协作、能发布。


盒子提供的能力一览

能力说明相关文档
把脚本变成软件自动装运行时、装依赖,脚本直接可运行5 分钟快速上手脚本运行机制
多场景触发右键菜单、快捷键、超级复制、定时任务,一键接入右键菜单 / 快捷键 / 超级复制
免写 GUI声明参数,盒子自动生成运行设置界面自动生成运行界面
数据进出选中文件、剪贴板文本自动传进脚本,结果自动回传参数传递机制输入输出契约
环境一键就绪7 种语言、外部工具、AI 模型全部自动下载配置环境配置
脚本协作脚本调脚本,组合出复合功能脚本联动
交付分发ZIP 打包、Git 分发、发布到社区自动更新打包与分发

怎么用这个文档

不用按顺序读。 找到你要做的事,读那几篇就够了:

我要做什么读这几篇
5 分钟跑通第一个脚本5 分钟快速上手
搞懂盒子怎么跑我的脚本脚本运行机制
让脚本出现在右键 / 快捷键右键菜单 / 快捷键参数传递机制
控制脚本弹不弹窗口终端模式详解
让用户运行前配置参数自动生成运行界面
用第三方库 / 外部工具环境配置外部二进制工具
脚本要用到 AI 模型模型下载
脚本定时自动运行定时任务
把多个脚本串起来节点脚本联动HTTP API
把脚本发给别人 / 发布到市场打包与分发发布脚本到社区
看看别人怎么写的完整示例
出问题了常见问题

盒子怎么运行你的脚本

整个机制只有一句话:盒子启动时,把一个 JSON 参数文件的路径塞进命令行第一个参数。你的脚本读它、干活、退出。

bash
# 盒子实际执行的命令,就长这样
python main.py "C:/Users/xxx/AppData/Local/Temp/a1b2c3d4.json"
#              └── 命令行第一个参数 = 参数 JSON 文件的路径

没有 SDK,没有 import,没有基类要继承。你的脚本换个地方照样能跑,只是没人给它传参数而已。详细机制见 脚本运行机制


声明式接入

盒子遵循声明式接入:只需要一个 bm-scripts-box-rc.toml 文件,用纯文本声明"脚本叫什么、用什么语言写、在哪里触发"。剩下的交给盒子。

维度传统 SDK / 插件方式不忙脚本盒子(声明式接入)
代码侵入需要 import sdk、继承基类、实现固定接口零侵入,原生脚本,无需任何改动
学习成本需要学习 SDK 的 API 规范会写脚本就会用
配置文件XML / JSON 配置 + 代码注解混合单一 TOML 文件,纯声明,无逻辑
触发集成需要在代码中注册事件监听在 TOML 中声明 enabled = true 即可
环境管理用户自己装语言、配环境变量盒子全自动处理
迁移成本换平台需重写接口适配层本身就是标准脚本,随时可独立运行

配置文件的所有字段见 配置文件详解


还没实现的功能

文档中标 🚧 的条目表示当前版本不可用,属于预留设计:


如果你发现文档中有错误,欢迎在 GitHub Issues 提交。

文档版本 0.3.0 · MIT License