From 2bfd823c09898f58722a1f8f30edfd46a1ea5efd Mon Sep 17 00:00:00 2001 From: amnweb <16545063+forumwt@users.noreply.github.com> Date: Sun, 20 Oct 2024 22:40:03 +0200 Subject: [PATCH] Add YASB CLI documentation --- docs/CLI.md | 41 +++++++++++++++++++++++++++++++++++++++++ docs/_Sidebar.md | 1 + 2 files changed, 42 insertions(+) create mode 100644 docs/CLI.md diff --git a/docs/CLI.md b/docs/CLI.md new file mode 100644 index 0000000..201ae5e --- /dev/null +++ b/docs/CLI.md @@ -0,0 +1,41 @@ +# YASB CLI (Command Line Interface) + +The YASB CLI is a command line interface that allows you to interact with the YASB configuration and status bar. The CLI is a powerful tool that allows you to manage your YASB configuration, start, stop, enable autostart, disable autostart, and reload the status bar. + +## 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. +- `reload` - Reload the status bar configuration. +- `log` - Show the status bar logs in the terminal. +- `help` - Show the help message. + +## Options +- `--help` - Show the help message for the command. +- `--version` - Show the YASB version. + +## Autostart + +To enable autostart for the status bar on system boot, use the following command: +```bash +yasbc enable-autostart +``` +To disable autostart for the status bar on system boot, use the following command: +```bash +yasbc disable-autostart + +To create task scheduler for autostart on windows, use the following command: +```bash +yasbc enable-autostart --task +``` + +To disable task scheduler for autostart on windows, use the following command: +```bash +yasbc disable-autostart --task +``` +> **Note:** +> Creating a task scheduler for autostart on Windows requires administrator privileges. \ No newline at end of file diff --git a/docs/_Sidebar.md b/docs/_Sidebar.md index 57bbced..3c9497a 100644 --- a/docs/_Sidebar.md +++ b/docs/_Sidebar.md @@ -2,6 +2,7 @@ - [Installation](./Installation) - [Configuration](./Configuration) - [Styling](./Styling) +- [YASB CLI](./CLI) - [FAQ](./FAQ) - Widgets: - [Active Windows Title](./(Widget)-Active-Windows-Title)