SketchyBar README

The project's README from github.com/FelixKratz/SketchyBar. As one markdown file: README.md.

Install • Documentation • Setups • Plugins

This bar project aims to create a highly flexible, customizable, fast and powerful status bar replacement for people that like playing with shell scripts.

More Setups

Features

The main design principle of this project is that all elements of the bar can be added, removed and freely changed at any point in time. Thus, the configuration of the bar is not static, rather it is possible to adapt the appearance of the bar completely dynamically with the help of a powerful event-driven scripting system at any point in time using the highly configurable basic building blocks SketchyBar offers.

Getting Started

Refer to the installation guide in the documentation to get the program set up. Once this is sorted you can start to become familiar with the syntax of sketchybar by going through the default sketchybarrc file and the default plugin scripts, which are located in ~/.config/sketchybar/ and look like this:

All commands and options are explained in detail in the relevant sections of the configuration documentation. You can try the commands directly from the commandline to see which affect they have and how they alter the bar. Once you have become familiar with the syntax you can look for a config to start from here or start from scratch and customize everything to your liking.

You might also enjoy looking at the Tips & Tricks section for some further tips on your journey. If you are searching for functional items you might want to check the plugins section if someone has already created what you are looking for.

Should you encounter things not working as you expect them to, please do not hesitate to open an issue, as this is either a bug or a documentation problem and relevant in any case.

Documentation

For the full documentation of all commands and properties please refer to the website.

If questions remain, feel free to consult the Q&A section.

Supporting

You can support this project is many ways:

Credits

This project was forked from spacebar and completely reimagined and rewritten.
The original idea is based on the status bar that was included in yabai before getting removed.

Some animation examples

https://user-images.githubusercontent.com/22680421/211198711-45318f04-e96f-4aa1-a0ba-c7f30f050902.mp4

SketchyBar (FelixKratz/SketchyBar)

Searching Database…

12.5K ·GitHub
SketchyBar
这是什么？SketchyBar 是一个高度可定制的 macOS 状态栏替代品，专为喜欢用 Shell 脚本打造状态栏的用户设计。
我是通过图形界面来设置，还是要编写脚本？没有设置用的图形界面。状态栏完全由 Shell 配置文件（sketchybarrc）和插件脚本驱动，并采用事件驱动的脚本系统，因此可以在运行时随时添加、移除或修改各个元素。
我要怎样才能在 Mac 上运行它？按照官方文档中的安装指南安装可执行文件，然后开始编辑默认的 sketchybarrc 以及位于 ~/.config/sketchybar/ 中的插件脚本。
它是否需要 yabai 或其他平铺式窗口管理器？不需要，SketchyBar 可以独立运行。但它源自 yabai 早先自带的状态栏（该功能后来被移除），因此经常与 yabai 搭配使用。
这究竟适合哪些人？主要面向 macOS 美化爱好者和平铺式窗口管理器用户，他们喜欢通过调整 Shell 脚本，打造完全自定义的状态栏，而不是使用默认样式。
除了 macOS，它还能在其他操作系统上运行吗？不能，它仅限 macOS，用于替代原生的 macOS 状态栏。
我可以在状态栏中显示应用图标或自定义图表吗？可以。SketchyBar 可以将正在运行的 macOS 菜单栏应用以别名形式显示在状态栏中，绘制任意图表，并为各个项目显示按需弹出的菜单。
什么是 SbarLua？SbarLua 是一个配套的 Lua API，可用 Lua 而非 Shell 编写 SketchyBar 配置脚本。此外还有 sketchybar-app-font 项目，提供用于状态栏的应用图标字形。
为什么要创建 SketchyBar，而不直接使用现有的状态栏？它派生自“spacebar”项目，并经过彻底重新设计；其最初的构想可追溯到 yabai 早先自带的状态栏（该功能后来被移除）。
What are similar projects?polybar, serpantinum, AgentOS, dots-hyprland, rift, ImmersionBar, rumps, shell
Which topics is it in?bar, status, statusbar, ricing, tiling-window-manager, window-manager, event-driven, scripting, dotfiles, menu-bar, interactive, shell
Creator
FelixKratz
Size
16.1 MB
Stars
12.5K
Updated
CommitOct 14Releasev2.24.1Oct 09
Age
5y
Commits · 90 Days