SwiftBar

SwiftBar

macOS菜单栏自定义程序开发工具

SwiftBar是一个开源的macOS菜单栏开发工具,支持通过shell脚本创建自定义菜单项。它提供了丰富的插件API,可实现动态内容显示、操作执行和点击响应。SwiftBar兼容BitBar插件,并内置插件仓库,方便用户获取和安装各类插件。SwiftBar可用于显示系统信息、控制应用程序、创建快捷方式等,增强了macOS菜单栏的功能性。

SwiftBarmacOS菜单栏插件自定义Github开源项目

GitHub 许可证 最新发布 GitHub 所有发布版本

<p align="center"> <img width="155" alt="SwiftBar 标志" src="https://yellow-cdn.veclightyear.com/0a4dffa0/b9c9bc42-cdba-451e-b1be-25175aaa648d.png"> </p>

SwiftBar

通过三个简单步骤在 macOS 上添加自定义菜单栏程序:

  • 编写一个shell脚本
  • 将其添加到SwiftBar
  • ...没有第三步!

你可以从优秀的 BitBar 仓库获取插件,或者在 SwiftBar 中使用"获取插件..."菜单项。

如何获取 SwiftBar

GitHub 发布页面 下载

或使用 Homebrew 安装

brew install swiftbar

运行在 macOS Catalina (10.15) 及以上版本。

...或从源代码构建

  • 克隆或下载此仓库的副本
  • 打开 SwiftBar/SwiftBar.xcodeproj
  • 点击运行

插件仓库

SwiftBar 内置了一个插件仓库。你可以通过 Swiftbar → 获取插件... 来访问它

<p align="center"> <img width="600" alt="SwiftBar 插件仓库的截图" src="https://yellow-cdn.veclightyear.com/0a4dffa0/189c9e5f-996d-45ba-b4ff-83721b0f178c.png"> </p>

如果你想添加\删除插件或对仓库内容有其他问题,请参阅此 issue

创建插件

要向 SwiftBar 添加新插件,你需要创建一个遵循所需格式(见下文)的可执行脚本,并将其放入"插件文件夹"。

插件文件夹

首次启动时,SwiftBar 会要求你设置"插件文件夹"。SwiftBar 将尝试将此文件夹中的每个文件导入为插件。

重要提示

  • 隐藏文件夹会被忽略
  • SwiftBar 会遍历嵌套文件夹,包括符号链接
  • 支持 .swiftbarignore 文件,你可以用它来排除不想作为插件导入的文件。

你可以通过在文件夹名前加上 . 或使用此命令 chflags hidden <文件夹名> 来隐藏文件夹。

插件命名

插件文件必须采用以下格式:

{名称}.{时间}.{扩展名}
  • 名称 - 任何你想要的内容。
  • 时间 - 刷新间隔(可选)。应为数字 + 持续时间修饰符(见下文)
  • 扩展名 - 文件扩展名。

持续时间修饰符:

  • ms - 毫秒,例如 1ms - 每毫秒刷新一次
  • s - 秒,例如 1s - 每秒刷新一次
  • m - 分钟,例如 10m - 每十分钟刷新一次
  • h - 小时,例如 3h - 每三小时刷新一次
  • d - 天,例如 1d - 每天刷新一次

文件名示例:date.1m.sh

无论你使用的是插件仓库中的插件,还是自己创建的插件,插件最初会以无特定顺序出现在菜单栏中。但是,你可以通过按住 <kbd>Cmd</kbd> 键并拖动它们来重新排序(这个过程有时也可以用于菜单栏中的一些其他非 SwiftBar 图标)。插件位置将被记住,除非你更改插件文件的名称,在这种情况下,它们需要重新定位。

插件 API

插件是用你选择的语言编写的可执行脚本。当 SwiftBar 在"插件文件夹"中检测到新文件时,它会在需要时使该文件可执行,并运行它。

脚本应该以所需格式(见下一章)产生输出(STDOUT)。脚本错误应重定向到 STDERR

插件 API 采用自 BitBar\xbar,这意味着 SwiftBar 可以运行任何现有的 BitBar\xbar 插件。

脚本输出

在解析插件输出时,SwiftBar 识别以下块:

  • 头部:负责你在菜单栏中看到的内容
  • 主体:负责下拉菜单的内容

头部是第一个 --- 之前的所有内容。第一个 --- 之后的每个 --- 将被解释为菜单分隔符。 你可以在头部有一行或多行。

最简单的插件看起来像这样:

echo "这是菜单标题"

如果你提供多个标题,提供的标题将在菜单栏中循环显示,并在下拉菜单中显示:

echo "这是主要菜单标题" echo "这是次要菜单标题" echo "这是第 n 个菜单标题" echo "---" echo "这不是菜单标题,这只会在下拉菜单中显示"

头部和主体的脚本输出都按行(\n)分割。每行必须遵循以下格式:

<项目标题> | [参数 = ...] 

其中:

  • "项目标题" 可以是任何字符串,这将用作菜单项标题。
  • [参数 = ...] 是一组可选的参数\修饰符。每个参数是由 = 分隔的键值对。使用 | 将参数与标题分开。

参数

文本格式化

参数描述
colorCSS颜色或十六进制值,浅色,深色设置项目文本颜色。如果只提供一种颜色,则同时用于浅色和深色外观。
sfcolorCSS颜色或十六进制值,浅色,深色设置SF符号颜色。如果只提供一种颜色,则同时用于浅色和深色外观。如果有多个SF符号,可以通过添加索引提供不同颜色,例如sfcolor2
fontmacOS字体名称设置项目文本使用的字体名称
size数字设置项目文本大小
mdTrue在菜单标题中启用markdown支持,用于**粗体***斜体*
sfsize数字设置嵌入文本中的SF符号图像大小
length数字将项目文本裁剪至指定字符数。完整标题将在工具提示中显示。
trimTrue裁剪空白字符
ansiTrue启用ANSI颜色代码支持。与以下参数冲突: symbolize
emojizeFalse禁用GitHub风格表情符号的解析(例如,:mushroom:转换为🍄)。当设置为true时需要: symbolize=false
symbolizeFalse禁用SF符号的解析(例如,"SF Symbols Test :sun.max: :cloud.fill: :gamecontroller.fill: :bookmark: :sun.dust:"<img width="218" alt="SF符号截图" src="https://yellow-cdn.veclightyear.com/0a4dffa0/aaa76ac3-5784-454e-a53a-0b0ab83a8c43.png">)。在Catalina上始终为False

视觉效果

参数描述
dropdownFalse仅适用于Header中的项目。设置为False时,项目将不会显示在下拉菜单中,但会在菜单栏中循环显示。
alternateTrue将一行标记为前一行的替代选项,用于在下拉菜单中按Option键(<kbd style="font-size:medium"></kbd>)时显示。
imageBase64编码的图像,浅色图像,深色图像为项目设置图像。如果只提供一个图像,则同时用于浅色和深色外观。
templateImageBase64编码的图像image相同,但图像是模板图像。模板图像由黑色和透明色(以及alpha通道)组成。模板图像不适合作为独立图像使用,通常与其他内容混合以创建所需的最终外观。
sfimageSF符号名称SF符号为项目设置图像。仅在Big Sur及更高版本可用。
sfconfigSF符号配置配置sfimage渲染模式。接受base64编码的json,示例json:{"renderingMode":"Palette", "colors":["red","blue"], "scale": "large", "weight": "bold"}。原始问题 #354
checkedTrue在项目前设置一个勾选标记。
tooltip文本为项目设置工具提示。
webviewTrue将提供的href作为网页视图呈现,而不是标准菜单栏菜单
webvieww数字设置网页视图宽度(像素)
webviewh数字设置网页视图高度(像素)

操作

参数描述
refreshTrue点击项目时将执行插件脚本
href绝对URL设置点击项目时要打开的URL
bash绝对文件路径在Shell中运行的可执行脚本
terminalFalsebash脚本将在后台运行,而不是启动终端
paramsparam0=,param1=,param10=...bash脚本的参数
shortcutCMD+OPTION+T分配给项目的热键。如果项目在头部,热键将显示菜单;否则,热键将启动相关操作。

环境变量

当运行插件时,SwiftBar 会设置以下环境变量:

变量
SWIFTBAR1
SWIFTBAR_VERSION正在运行的 SwiftBar 版本号(格式为 x.y.z
SWIFTBAR_BUILD正在运行的 SwiftBar 构建号(CFBundleVersion
SWIFTBAR_PLUGINS_PATH插件文件夹的路径
SWIFTBAR_PLUGIN_PATH正在运行的插件的路径
SWIFTBAR_PLUGIN_CACHE_PATH缓存数据文件夹的路径,每个插件独立
SWIFTBAR_PLUGIN_DATA_PATH数据文件夹的路径,每个插件独立
SWIFTBAR_PLUGIN_REFRESH_REASON插件刷新原因\触发器
SWIFTBAR_LAUNCH_TIMESwiftBar 启动日期和时间,ISO8601 格式
OS_APPEARANCE当前 macOS 外观(LightDark
OS_VERSION_MAJORmacOS 版本的第一部分(例如,macOS 11.0.1 中的 11
OS_VERSION_MINORmacOS 版本的第二部分(例如,macOS 11.0.1 中的 0
OS_VERSION_PATCHmacOS 版本的第三部分(例如,macOS 11.0.1 中的 1
OS_LAST_SLEEP_TIME上次操作系统睡眠日期和时间,ISO8601 格式。如果自 SwiftBar 启动以来操作系统未睡眠,则为空。
OS_LAST_WAKE_TIME上次操作系统从睡眠唤醒的日期和时间,ISO8601 格式。如果自 SwiftBar 启动以来操作系统未睡眠,则为空。

脚本元数据

建议在插件脚本中包含元数据。元数据用于 SwiftBar 的"关于插件"界面中。 SwiftBar 采用了 BitBar\xbar 建议的元数据格式:

# <xbar.title>标题在此</xbar.title>
# <xbar.version>v1.0</xbar.version>
# <xbar.author>你的名字</xbar.author>
# <xbar.author.github>你的 github 用户名</xbar.author.github>
# <xbar.desc>简短描述你的插件功能。</xbar.desc>
# <xbar.image>http://www.hosted-somewhere/pluginimage</xbar.image>
# <xbar.dependencies>python,ruby,node</xbar.dependencies>
# <xbar.abouturl>http://url-to-about.com/</xbar.abouturl>
# <xbar.droptypes>支持拖放到菜单栏的 UTI</xbar.droptypes>

隐藏默认项目

SwiftBar 支持这些可选的元数据标记来隐藏默认菜单项:

# <swiftbar.hideAbout>true</swiftbar.hideAbout>
# <swiftbar.hideRunInTerminal>true</swiftbar.hideRunInTerminal>
# <swiftbar.hideLastUpdated>true</swiftbar.hideLastUpdated>
# <swiftbar.hideDisablePlugin>true</swiftbar.hideDisablePlugin>
# <swiftbar.hideSwiftBar>true</swiftbar.hideSwiftBar>

按住 Option 键点击将显示所有项目: SwiftBar

刷新计划

可以使用特殊标签作为插件名称中定义的刷新间隔的替代方案,值采用 Cron 语法:

<swiftbar.schedule>01,16,31,46 * * * *</swiftbar.schedule>

你可以配置多个计划,使用分隔符 |

<swiftbar.schedule>1 * * * *|2 * * * *</swiftbar.schedule>

其他参数

  • <swiftbar.refreshOnOpen>true</swiftbar.refreshOnOpen> - 在点击时刷新插件,然后显示菜单
  • <swiftbar.runInBash>false</swiftbar.runInBash> - 运行时不将插件包装在 Bash 中
  • <swiftbar.type>streamable</swiftbar.type> - 将插件标记为可流式传输
  • <swiftbar.environment>[var1=默认值, var2=默认值, ... ]</swiftbar.environment> - 这些变量将传递到插件的环境中,在后续版本中 SwiftBar 将提供一个 UI 来更改这些变量的值。
  • <swiftbar.persistentWebView>true</swiftbar.persistentWebView> - 使 WebView 持久化,这样每次点击菜单栏时不会重新加载

二进制插件的元数据

对于二进制插件,可以将元数据添加为扩展文件属性:

xattr -w "com.ameba.SwiftBar" "$(cat metadata.txt | base64)" <plugin_file>

插件类型

标准(默认)

对于标准类型的插件,SwiftBar 期望插件执行是有限的,即插件运行并以输出到 stdout 结束:

  • 以代码 0 退出并有非空 stdout - 菜单栏根据输出构建
  • 以代码 0 退出并有空 stdout - 菜单栏中没有内容
  • 以代码 1 退出 - 菜单栏中显示错误

可选地,标准插件可以按可重复的计划运行,在插件的文件名或 schedule 元数据属性中配置。

快捷方式

这种插件类型针对想要使用快捷方式应用创建菜单栏项目的人。插件 API 与标准类型基本相同。创建一个以所需格式输出文本的快捷方式,在 SwiftBar 设置的快捷方式插件部分选择此快捷方式,就可以使用了。

对于快捷方式插件,SwiftBar 提供了一个方便的 UI 来配置刷新计划。

示例快捷方式:

临时

临时插件通过运行 SwiftBar 的快捷方式操作或调用 URL 方案按需创建菜单栏项目。插件 API 与标准类型基本相同。 以下是URL方案的参数:

  • name - 插件名称,应该是唯一的
  • content - 你希望SwiftBar渲染的标记
  • exitafter - 这是一个可选参数,强制插件在指定的时间后退出,以秒为单位。默认为0,表示"不退出"。

快捷方式操作是不言自明的。

这种插件类型最适合用于通知或其他临时菜单栏项目。

可流式传输

SwiftBar为每个可流式传输插件启动一个单独的进程,该进程会一直运行,直到SwiftBar关闭或出现故障。 你应该只在处理incoming事件流时使用可流式传输插件;例如可以是从websocket读取的金融市场信息或远程计算机的CPU负载信息。

为了让SwiftBar知道何时更新菜单栏项目,可流式传输插件必须使用特殊的行分隔符~~~。SwiftBar将在每次出现此分隔符时重置菜单项。

在下面的例子中,SwiftBar将在菜单栏中显示"Test 1"3秒,然后空白5秒,最后无限期地显示"Test 2"。

#!/bin/bash
#<swiftbar.type>streamable</swiftbar.type>

echo "Test 1"
echo "---"
echo "Test 2"
echo "Test 3"
sleep 3
echo "~~~"
sleep 5
echo "~~~"
echo "Test 2"

你可以使用特殊的元数据属性<swiftbar.type>streamable</swiftbar.type>将插件标记为可流式传输。

URL方案

一些注意事项:

  • 除了插件名称,你还可以(并且可能应该)使用插件文件名。这被视为唯一的插件ID,而name在多个插件之间可能相同。如果你的插件文件路径是~/Documents/SwiftBar/myplugin.1m.sh,那么名称是myplugin,ID是myplugin.1m.sh
  • 当使用open(1)触发方案URL时,使用-g来防止命令从你的活动应用程序中抢夺焦点。
端点参数描述示例
refreshallplugins强制刷新所有已加载的插件swiftbar://refreshallplugins
refreshpluginnameplugin插件名称按名称强制刷新插件。如果提供,额外的URL参数会作为环境变量暴露给插件swiftbar://refreshplugin?name=myplugin
refreshpluginindex插件在菜单栏中的索引,从0开始按菜单栏中的位置强制刷新插件swiftbar://refreshplugin?index=1
enablepluginnameplugin插件名称按名称启用插件swiftbar://enableplugin?name=myplugin
disablepluginnameplugin插件名称按名称禁用插件swiftbar://disableplugin?name=myplugin
togglepluginnameplugin插件名称切换(启用\禁用)插件(按名称)swiftbar://toggleplugin?name=myplugin
addpluginsrc插件文件的源URL从URL添加插件到Swiftbarswiftbar://addplugin?src=https://coolplugin
notifynameplugin插件名称。通知字段:titlesubtitlebodyhref在点击时打开URL(包括自定义URL方案)。silent=true禁用声音显示通知swiftbar://notify?plugin=MyPlugin&title=title&subtitle=subtitle&body=body&silent=true
setephemeralpluginname插件名称,应该是唯一的。content - 插件内容,exitafter - 可选设置菜单栏的生命周期(秒)创建临时插件。要删除现有的临时插件,将其内容设置为空字符串""swiftbar://setephemeralplugin?name=ephemeral&content=hi

首选项即'defaults'

SwiftBar UI中未暴露的首选项列表:

  • defaults write com.ameba.SwiftBar StealthMode -bool YES - 当所有插件都被禁用时隐藏SwiftBar菜单项
  • defaults write com.ameba.SwiftBar DisableBashWrapper -bool YES - 运行时不将插件包装在Bash中
  • defaults write com.ameba.SwiftBar MakePluginExecutable -bool NO - 禁用自动对插件目录中的所有文件执行chmod +x
  • defaults write com.ameba.SwiftBar PluginDeveloperMode -bool YES - 在首选项 -> 插件中启用编辑
  • defaults write com.ameba.Swiftbar PluginDebugMode -bool YES - 启用插件调试视图
  • defaults write com.ameba.SwiftBar StreamablePluginDebugOutput -bool YES - 为可流式传输插件启用调试输出,Swiftbar将在Console.App中显示流数据

日志和错误

如果插件运行失败,SwiftBar将在菜单栏中显示⚠️,你可以通过点击下拉菜单中的Error查看详细信息。 使用macOS的Console.app查看SwiftBar日志。

致谢

SwiftBar使用了这些开源库:

为了冻结和保护依赖项,这些库被分叉到SwiftBar组织。

翻译/本地化

SwiftBar可以在这里进行翻译。

更多应用

如果你喜欢SwiftBar,你可能也会喜欢以下这些:

  • TRex - 一款适用于macOS的易用文本提取工具
  • Esse - 适用于iOS和macOS的文本转换瑞士军刀

编辑推荐精选

蛙蛙写作

蛙蛙写作

AI小说写作助手,一站式润色、改写、扩写

蛙蛙写作—国内先进的AI写作平台,涵盖小说、学术、社交媒体等多场景。提供续写、改写、润色等功能,助力创作者高效优化写作流程。界面简洁,功能全面,适合各类写作者提升内容品质和工作效率。

AI辅助写作AI工具蛙蛙写作AI写作工具学术助手办公助手营销助手AI助手
Trae

Trae

字节跳动发布的AI编程神器IDE

Trae是一种自适应的集成开发环境(IDE),通过自动化和多元协作改变开发流程。利用Trae,团队能够更快速、精确地编写和部署代码,从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能,是提升开发效率的理想工具。

AI工具TraeAI IDE协作生产力转型热门
问小白

问小白

全能AI智能助手,随时解答生活与工作的多样问题

问小白,由元石科技研发的AI智能助手,快速准确地解答各种生活和工作问题,包括但不限于搜索、规划和社交互动,帮助用户在日常生活中提高效率,轻松管理个人事务。

热门AI助手AI对话AI工具聊天机器人
Transly

Transly

实时语音翻译/同声传译工具

Transly是一个多场景的AI大语言模型驱动的同声传译、专业翻译助手,它拥有超精准的音频识别翻译能力,几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球,无论你是留学生、商务人士、韩剧美剧爱好者,还是出国游玩、多国会议、跨国追星等等,都可以满足你所有需要同传的场景需求,线上线下通用,扫除语言障碍,让全世界的语言交流不再有国界。

讯飞智文

讯飞智文

一键生成PPT和Word,让学习生活更轻松

讯飞智文是一个利用 AI 技术的项目,能够帮助用户生成 PPT 以及各类文档。无论是商业领域的市场分析报告、年度目标制定,还是学生群体的职业生涯规划、实习避坑指南,亦或是活动策划、旅游攻略等内容,它都能提供支持,帮助用户精准表达,轻松呈现各种信息。

AI办公办公工具AI工具讯飞智文AI在线生成PPTAI撰写助手多语种文档生成AI自动配图热门
讯飞星火

讯飞星火

深度推理能力全新升级,全面对标OpenAI o1

科大讯飞的星火大模型,支持语言理解、知识问答和文本创作等多功能,适用于多种文件和业务场景,提升办公和日常生活的效率。讯飞星火是一个提供丰富智能服务的平台,涵盖科技资讯、图像创作、写作辅助、编程解答、科研文献解读等功能,能为不同需求的用户提供便捷高效的帮助,助力用户轻松获取信息、解决问题,满足多样化使用场景。

热门AI开发模型训练AI工具讯飞星火大模型智能问答内容创作多语种支持智慧生活
Spark-TTS

Spark-TTS

一种基于大语言模型的高效单流解耦语音令牌文本到语音合成模型

Spark-TTS 是一个基于 PyTorch 的开源文本到语音合成项目,由多个知名机构联合参与。该项目提供了高效的 LLM(大语言模型)驱动的语音合成方案,支持语音克隆和语音创建功能,可通过命令行界面(CLI)和 Web UI 两种方式使用。用户可以根据需求调整语音的性别、音高、速度等参数,生成高质量的语音。该项目适用于多种场景,如有声读物制作、智能语音助手开发等。

咔片PPT

咔片PPT

AI助力,做PPT更简单!

咔片是一款轻量化在线演示设计工具,借助 AI 技术,实现从内容生成到智能设计的一站式 PPT 制作服务。支持多种文档格式导入生成 PPT,提供海量模板、智能美化、素材替换等功能,适用于销售、教师、学生等各类人群,能高效制作出高品质 PPT,满足不同场景演示需求。

讯飞绘文

讯飞绘文

选题、配图、成文,一站式创作,让内容运营更高效

讯飞绘文,一个AI集成平台,支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容,加速品牌传播,提升内容营销效果。

热门AI辅助写作AI工具讯飞绘文内容运营AI创作个性化文章多平台分发AI助手
材料星

材料星

专业的AI公文写作平台,公文写作神器

AI 材料星,专业的 AI 公文写作辅助平台,为体制内工作人员提供高效的公文写作解决方案。拥有海量公文文库、9 大核心 AI 功能,支持 30 + 文稿类型生成,助力快速完成领导讲话、工作总结、述职报告等材料,提升办公效率,是体制打工人的得力写作神器。

下拉加载更多