diff --git a/crates/sss_cli/README.md b/crates/sss_cli/README.md new file mode 100644 index 0000000..4500909 --- /dev/null +++ b/crates/sss_cli/README.md @@ -0,0 +1,47 @@ +# SSS +Terminal tool to take screenshots of your screen + + +## Usage + +> [!IMPORTANT] +> You need use the slurp format for the area + +```sh +Usage: sss [OPTIONS] + +Options: + --current When you take from a screen or window, capture the one on which the mouse is located. + --show-cursor Capture cursor (Only Wayland) + --screen Capture a full screen + --area Captures an area of the screen + --font [default: Hack=12.0;] The font used to render, format: Font Name=size;Other Font Name=12.0 [default: Hack=12.0;] + -b, --background Support: '#RRGGBBAA' 'h;#RRGGBBAA;#RRGGBBAA' 'v;#RRGGBBAA;#RRGGBBAA' or file path [default: #323232] + -r, --radius [default: 15] + --author Author Name of screenshot + --author-color Title bar text color [default: #FFFFFF] + --author-font Font to render Author [default: Hack] + --window-controls Whether show the window controls + --window-title Window title + --windows-background Window bar background [default: #4287f5] + --windows-title-color Title bar text color [default: #FFFFFF] + --window-controls-width Width of window controls [default: 120] + --window-controls-height Height of window title/controls bar [default: 40] + --titlebar-padding Padding of title on window bar [default: 10] + --padding-x [default: 80] + --padding-y [default: 100] + --shadow Enable shadow + --shadow-image Generate shadow from inner image + --shadow-color Support: '#RRGGBBAA' 'h;#RRGGBBAA;#RRGGBBAA' 'v;#RRGGBBAA;#RRGGBBAA' or file path [default: #707070] + --shadow-blur [default: 50] + -c, --just-copy Send the result to your clipboard + --save-path If it is set then the result will be saved here, otherwise it will not be saved. [default: None] + -f, --save-format The format in which the image will be saved [default: png] + -h, --help Print help + -V, --version Print version +``` + +## Capture Area +```sh +sss --area "$(slurp)" --window-controls --windows-background "#ffffff" --author "SergioRibera" --save-path out.png +```