YASB CLI (Command Line Interface)

The YASB CLI is a command line interface that allows you to interact with the YASB status bar. The CLI is a powerful tool that allows you to manage your YASB bar, start, stop, enable autostart, disable autostart, reload, update and watch the logs in the terminal.

Usage

yasbc [command] [options]

Commands

  • start - Start the status bar.
  • stop - Stop the status bar.
  • enable-autostart - Enable autostart for the status bar on system boot.
  • disable-autostart - Disable autostart for the status bar on system boot.
  • enable-crash-dumps - Save a crash dump file when YASB crashes.
  • disable-crash-dumps - Stop saving crash dump files.
  • reload - Reload the status bar configuration.
  • monitor-information - Show information about connected monitors.
  • hide-bar - Hide the status bar.
  • show-bar - Show the status bar.
  • toggle-bar - Toggle the visibility of the status bar.
  • update - Update the application to the latest version.
  • set-channel - Set the update channel (stable, preview).
  • migrate-config - Find and fix deprecated options in your configuration file.
  • log - Stream the status bar logs in real-time.
  • reset - Restore default config files and clear cache.
  • config-dir - Open the configuration directory in Windows File Explorer.
  • help - Show the help message.

Options

  • -h, --help - Show the help message.
  • -v, --version - Show the YASB and YASB-CLI versions.
  • -c, --config - Print the absolute path to your configuration folder.
  • -s, --silent - Disable normal print status messages for start, stop, and reload.

Note

You can use the --silent option with the start, stop and reload commands to prevent non-error messages from being displayed.

Autostart

To enable autostart for the status bar on system boot, use the following command:

yasbc enable-autostart

To disable autostart for the status bar on system boot, use the following command:

yasbc disable-autostart

To create task scheduler for autostart on windows, use the following command:

yasbc enable-autostart --task

To disable task scheduler for autostart on windows, use the following command:

yasbc disable-autostart --task

Note

Creating a task scheduler for autostart on Windows requires administrator privileges.

Crash Dumps

If YASB closes on its own with nothing in the log (a silent crash), Windows records the crash in Event Viewer but does not save a dump file, so there is nothing left to debug afterwards. To tell Windows to keep one, use the following command:

yasbc enable-crash-dumps

To stop saving crash dumps, use the following command:

yasbc disable-crash-dumps

Dumps are written to the dumps folder inside your configuration directory, and the last 5 are kept. When reporting a crash, attach the newest .dmp file together with your yasb.log.

Note

Enabling and disabling crash dumps requires administrator privileges. A dump is a snapshot of memory, so it can contain data from your configuration such as API keys or tokens.

Show and Hide the Status Bar

To hide the status bar on all screens, use the following command:

yasbc hide-bar

To hide the status bar on a specific screen, use the following command:

yasbc hide-bar --screen <screen_name>

To show the status bar on all screens, use the following command:

yasbc show-bar

To show the status bar on a specific screen, use the following command:

yasbc show-bar --screen <screen_name>

To toggle the visibility of the status bar on all screens, use the following command:

yasbc toggle-bar

To toggle the visibility of the status bar on a specific screen, use the following command:

yasbc toggle-bar --screen <screen_name>

To update YASB to the latest version with current update channel, use the following command:

yasbc update

Reset YASB

To reset YASB to the default config files and clear cache, use the following command:

yasbc reset

Note

This will remove all config files and clear cache.

Switch Update Channel

To switch the update channel to preview, use the following command:

yasbc set-channel preview

Open Configuration Folder

To quickly locate your settings, you can print the config folder path:

yasbc --config

Or open the folder directly in Windows File Explorer:

yasbc config-dir

Streaming Live Logs

To watch live log entries generated by YASB (very helpful for debugging custom widgets or styles):

yasbc log

Note

Set debug: true in your config.yaml if you want verbose logs. Press Ctrl+C in your terminal to exit the log viewer.

Upgrading Old Configurations

If you've updated YASB and want to check if your existing config.yaml contains any outdated settings:

yasbc migrate-config

This tool scans your settings, shows you which options will be renamed or removed, and prompts you before applying changes. A backup file (config.yaml.bak) is automatically created before any edits are made.