yasb-docs
npx skills add https://github.com/quantmind-br/skills --skill yasb-docs
Agent 安装分布
Skill 文档
YASB (Yet Another Status Bar)
A highly customizable status bar for Windows 10/11 with support for widgets, CSS styling, global keybindings, and Python-based plugin development. Configured via YAML and styled with CSS.
Quick Start
# config.yaml - Minimal status bar configuration
bars:
status-bar:
enabled: true
screens: ['*']
dimensions:
width: "100%"
height: 36
widgets:
left: ["clock"]
center: ["cpu"]
right: ["memory"]
widgets:
clock:
type: "yasb.clock.ClockWidget"
options:
label: "{%H:%M}"
keybindings:
- keys: "win+c"
action: "toggle_calendar"
Installation
winget install --id AmN.yasb
Alternative methods: Scoop (scoop install extras/yasb), Chocolatey (choco install yasb), or manual MSI from releases.
Documentation
Full documentation in docs/. See docs/000-index.md for detailed navigation.
By Topic
| Topic | Files | Description |
|---|---|---|
| Getting Started | 001-002 | Project overview and installation |
| Configuration | 003-004 | YAML config files, env vars, keybindings |
| Customization | 005 | CSS styling, dark mode, Nerd Fonts, shadows |
| Development | 006, 008 | Custom widget creation, contributing guide |
| Usage | 007 | CLI commands and automation |
| Support | 009 | FAQ and troubleshooting |
By Keyword
| Keyword | File |
|---|---|
| windows | 001, 002 |
| status-bar | 001, 003, 007 |
| installation | 002, 009 |
| winget | 002 |
| scoop | 002 |
| chocolatey | 002 |
| build-from-source | 002 |
| configuration | 003, 004, 009 |
| config.yaml | 003, 009 |
| yaml | 003 |
| environment-variables | 003 |
| .env | 003 |
| font-engine | 003 |
| multiple-bars | 003 |
| screens | 003 |
| blur-effect | 003, 009 |
| window-flags | 003 |
| auto-hide | 003 |
| keybindings | 004 |
| hotkeys | 004 |
| keyboard-shortcuts | 004 |
| modifier-keys | 004 |
| css-customization | 005, 009 |
| styles.css | 005, 009 |
| dark-mode | 005 |
| nerd-fonts | 005, 009 |
| context-menu | 005 |
| tooltip | 005 |
| shadow | 005 |
| widget-container | 005 |
| widget-development | 006 |
| python | 006, 008 |
| pydantic | 006 |
| qt-framework | 006 |
| BaseWidget | 006 |
| validation-schema | 006 |
| callbacks | 006 |
| cli | 007 |
| yasbc | 007 |
| autostart | 007 |
| hide-bar | 007 |
| show-bar | 007 |
| toggle-bar | 007 |
| reload | 007 |
| update-channel | 007 |
| contributing | 008 |
| ruff | 008 |
| pre-commit | 008 |
| troubleshooting | 009 |
| faq | 009 |
| weather-widget | 009 |
| cpu-usage | 009 |
Learning Path
- Foundation – Read
001(overview) â Complete002(install YASB) - Core Config – Learn config from
003â Set up keybindings with004 - Customization – Style with CSS in
005(dark mode, Nerd Fonts, shadows) - Development – Build custom widgets with
006(Python, Pydantic, Qt) â Contribute via008 - Reference – CLI commands in
007â Troubleshoot with009
Common Tasks
Install YASB on Windows
â docs/002-installation.md (winget, scoop, chocolatey, manual MSI, or source build)
Configure the Status Bar
â docs/003-configuration.md (YAML config, bar dimensions, screens, blur effect, window flags)
Set Up Multiple Bars on Different Screens
â docs/003-configuration.md (screen assignment: ['*'], ['**'], or specific monitor names)
Set Up Keyboard Shortcuts
â docs/004-keybindings.md (global hotkeys per widget, modifier keys, supported key names)
Customize Appearance with CSS
â docs/005-styling.md (bar styling, widget classes, dark mode, context menus, tooltips, shadows)
Create a Custom Widget
â docs/006-writing-widget.md (BaseWidget, Pydantic validation, Qt layout, callbacks)
Manage YASB via CLI
â docs/007-cli.md (start/stop, autostart, reload, hide/show/toggle bar, update, logs)
Troubleshoot Common Issues
â docs/009-faq.md (icons not showing, blur not working, config location, high CPU, CSS issues)