Skip to content

Commit

Permalink
feat: add sss cli readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SergioRibera committed Jan 13, 2024
1 parent f15d4d8 commit 6be0093
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions crates/sss_cli/README.md
Original file line number Diff line number Diff line change
@@ -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 <AREA> Captures an area of the screen
--font <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 <BACKGROUND> Support: '#RRGGBBAA' 'h;#RRGGBBAA;#RRGGBBAA' 'v;#RRGGBBAA;#RRGGBBAA' or file path [default: #323232]
-r, --radius <RADIUS> [default: 15]
--author <AUTHOR> Author Name of screenshot
--author-color <AUTHOR_COLOR> Title bar text color [default: #FFFFFF]
--author-font <AUTHOR_FONT> Font to render Author [default: Hack]
--window-controls Whether show the window controls
--window-title <WINDOW_TITLE> Window title
--windows-background <WINDOWS_BACKGROUND> Window bar background [default: #4287f5]
--windows-title-color <WINDOWS_TITLE_COLOR> Title bar text color [default: #FFFFFF]
--window-controls-width <WINDOW_CONTROLS_WIDTH> Width of window controls [default: 120]
--window-controls-height <WINDOW_CONTROLS_HEIGHT> Height of window title/controls bar [default: 40]
--titlebar-padding <TITLEBAR_PADDING> Padding of title on window bar [default: 10]
--padding-x <PADDING_X> [default: 80]
--padding-y <PADDING_Y> [default: 100]
--shadow Enable shadow
--shadow-image Generate shadow from inner image
--shadow-color <SHADOW_COLOR> Support: '#RRGGBBAA' 'h;#RRGGBBAA;#RRGGBBAA' 'v;#RRGGBBAA;#RRGGBBAA' or file path [default: #707070]
--shadow-blur <SHADOW_BLUR> [default: 50]
-c, --just-copy Send the result to your clipboard
--save-path <SAVE_PATH> If it is set then the result will be saved here, otherwise it will not be saved. [default: None]
-f, --save-format <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
```

0 comments on commit 6be0093

Please sign in to comment.