-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters