Skip to content

Commit

Permalink
Add YASB CLI documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
amnweb committed Oct 20, 2024
1 parent c7104d9 commit 2bfd823
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
41 changes: 41 additions & 0 deletions docs/CLI.md
Original file line number Diff line number Diff line change
@@ -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.
1 change: 1 addition & 0 deletions docs/_Sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
- [Installation](./Installation)
- [Configuration](./Configuration)
- [Styling](./Styling)
- [YASB CLI](./CLI)
- [FAQ](./FAQ)
- Widgets:
- [Active Windows Title](./(Widget)-Active-Windows-Title)
Expand Down

0 comments on commit 2bfd823

Please sign in to comment.