servicepoint/servicepoint-cli
0
1
Fork 0
Code Issues Pull requests Actions Packages Projects Releases 2 Wiki Activity

update README.md usage
All checks were successful
Rust / build (pull_request) Successful in 8m30s
Details

Browse source
This commit is contained in:
Vinzenz Schroeter 2025-05-04 15:48:49 +02:00
parent 51c60250fb
commit 8f3c209fa3
1 changed files with 23 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -33,15 +33,15 @@ cargo run -- <args>
## Usage ## Usage
``` ```text
Usage: servicepoint-cli [OPTIONS] <COMMAND> Usage: servicepoint-cli [OPTIONS] <COMMAND>
Commands: Commands:
reset-everything Reset both pixels and brightness [aliases: r] reset Reset both pixels and brightness [aliases: r]
pixels Commands for manipulating pixels [aliases: p] pixels Commands for manipulating pixels [aliases: p]
brightness Commands for manipulating the brightness [aliases: b] brightness Commands for manipulating the brightness [aliases: b]
text Commands for sending text to the screen [aliases: t] text Commands for sending text to the screen [aliases: t]
help Print this message or the help of the given subcommand(s) help Print this message or the help of the given subcommand(s)
Options: Options:
-d, --destination <DESTINATION> ip:port of the servicepoint display [default: 127.0.0.1:2342] -d, --destination <DESTINATION> ip:port of the servicepoint display [default: 127.0.0.1:2342]
@ -53,7 +53,7 @@ Options:
### Pixels ### Pixels
``` ```text
Commands for manipulating pixels Commands for manipulating pixels
Usage: servicepoint-cli pixels <COMMAND> Usage: servicepoint-cli pixels <COMMAND>
@ -68,7 +68,7 @@ Commands:
#### Image #### Image
``` ```text
Send an image file (e.g. jpeg or png) to the display. Send an image file (e.g. jpeg or png) to the display.
Usage: servicepoint-cli pixels image [OPTIONS] <FILE_NAME> Usage: servicepoint-cli pixels image [OPTIONS] <FILE_NAME>
@ -87,7 +87,7 @@ Options:
#### Screen #### Screen
``` ```text
Stream the default screen capture source to the display. On Linux Wayland, this pops up a screen or window chooser, but it also may directly start streaming your main screen. Stream the default screen capture source to the display. On Linux Wayland, this pops up a screen or window chooser, but it also may directly start streaming your main screen.
Usage: servicepoint-cli pixels screen [OPTIONS] Usage: servicepoint-cli pixels screen [OPTIONS]
@ -104,7 +104,7 @@ Options:
### Brightness ### Brightness
``` ```text
Commands for manipulating the brightness Commands for manipulating the brightness
Usage: servicepoint-cli brightness <COMMAND> Usage: servicepoint-cli brightness <COMMAND>
@ -117,18 +117,18 @@ Commands:
### Text ### Text
``` ```text
Commands for sending text to the screen Commands for sending text to the screen
Usage: servicepoint-cli text <COMMAND> Usage: servicepoint-cli text <COMMAND>
Commands: Commands:
stdin Pipe text to the display, example: `journalctl | servicepoint-cli stream stdin` stdin Pipe text to the display, example: `journalctl | servicepoint-cli text stdin`
``` ```
#### Stdin #### Stdin
``` ```text
Pipe text to the display, example: `journalctl | servicepoint-cli stream stdin` Pipe text to the display, example: `journalctl | servicepoint-cli stream stdin`
Usage: servicepoint-cli stream stdin [OPTIONS] Usage: servicepoint-cli stream stdin [OPTIONS]
@ -137,6 +137,16 @@ Options:
-s, --slow Wait for a short amount of time before sending the next line -s, --slow Wait for a short amount of time before sending the next line
``` ```
### Reset
```text
Reset both pixels and brightness
Usage: servicepoint-cli reset [OPTIONS]
Options:
-f, --force hard reset screen
```
## Contributing ## Contributing