Snipaste

https://docs.snipaste.com
Admin
Snipaste is a productivity tool that combines a screenshot snipping utility with a powerful paste...
Tokens:318,433
Snippets:3,711
Trust Score:9.7
Update:9 months ago
Show doc for...
Tokens:
Raw
### Hotkey Configuration Example (Command Line)

Source: https://docs.snipaste.com/pro_id=snip

Example of how to configure a hotkey for a specific function using the command line. This demonstrates setting up a command and excluding specific applications.

```shell
snip --hotkey "Ctrl+Alt+S" "snip --last -o clipboard" --ignore-exe "a.exe" --ignore-path "games"
```

--------------------------------

### Example: Capture Fullscreen to Clipboard

Source: https://docs.snipaste.com/command-line-options_id=paste-options

Provides specific examples of how to capture the entire screen and copy it directly to the clipboard using Snipaste. The command structure differs slightly based on the installation source (e.g., executable path for desktop vs. direct command for Store version).

```shell
X:/path/to/your/Snipaste.exe snip --full -o clipboard

```

```shell
Snipaste snip --full -o clipboard

```

```shell
/Applications/Snipaste.app/Contents/MacOS/Snipaste snip --full -o clipboard

```

```shell
/path/to/your/Snipaste.AppImage snip --full -o clipboard

```

--------------------------------

### Basic Snipaste Usage Example

Source: https://docs.snipaste.com/command-line-options_id=examples

Demonstrates how to initiate Snipaste from the command line to capture a full screen and copy it to the clipboard. This example is platform-specific and shows variations for Windows, macOS, and Linux.

```bash
X:/path/to/your/Snipaste.exe snip --full -o clipboard
Snipaste snip --full -o clipboard
/Applications/Snipaste.app/Contents/MacOS/Snipaste snip --full -o clipboard
/path/to/your/Snipaste.AppImage snip --full -o clipboard
```

--------------------------------

### Snip, Save, OCR, and View Results with Notepad (Snipaste PRO)

Source: https://docs.snipaste.com/command-line-options

This command snips an area, saves it as 'source.png', uses Tesseract OCR to recognize text (English and Simplified Chinese), and then opens the recognized text in Notepad. This is a complex workflow requiring the PRO version and a Tesseract installation.

```shell
snip -o "d:\temp\source.png";exec(cmd /c "d:\Tesseract-OCR\tesseract.exe" "d:\temp\source.png" "d:\temp\ocr_res" -c preserve_interword_spaces=1 --oem 1 --psm 1 -l eng+chi_sim && notepad "d:\temp\ocr_res.txt")
```

--------------------------------

### Compatibility with Login Item on macOS Ventura (Mac, v2.8)

Source: https://docs.snipaste.com/changelog_id=v181

Ensures compatibility with the login item functionality on macOS Ventura. This guarantees that Snipaste starts correctly as a login item on this specific macOS version.

```bash
Compatibility with login item on macOS Ventura
```

--------------------------------

### Command Line Options - v2.7.2

Source: https://docs.snipaste.com/changelog_id=v282

Details command-line options related to screenshot refreshing and shadow handling in Snipaste version 2.7.2.

```APIDOC
## Command Line Options

### Screenshot Options (v2.7.2)

- `refresh screenshot`: Refreshes the screenshot while preserving existing annotations.
- `--shadow`: Starts a screenshot with a shadow effect.
- `--no-shadow`: Starts a screenshot without a shadow effect. This will not affect subsequent snipping operations.
```

--------------------------------

### Image Window Virtual Desktop Support on Windows 11

Source: https://docs.snipaste.com/changelog_id=v25

This feature enables Snipaste image windows to correctly function with virtual desktops on Windows 11. This improves window management and visibility in multi-desktop setups.

```text
[PRO] Image windows support virtual desktop on Windows 11
```

--------------------------------

### Command Line Options

Source: https://docs.snipaste.com/changelog_id=v184

This section details the various command-line options available for controlling Snipaste's behavior, including screenshot output, image management, and whiteboard customization.

```APIDOC
## Command Line Options

### Description

Provides a list of command-line options for controlling Snipaste's functionality.

### Method

N/A (Command Line Interface)

### Endpoint

N/A

### Parameters

#### Command Line Arguments

- **`whiteboard --color <color_name> --active-screen`** (string) - Optional - Customizes the whiteboard with a specified color and enables it only on the active screen.
- **`snip -o no-auto-save`** (string) - Optional - Configures screenshot output to skip automatic saving.
- **`show-group-manager`** (string) - Optional - Opens the Image Group Manager window.
- **`empty-group`** (string) - Optional - Clears the current image group.

### Request Example

```bash
snip --color black --active-screen
snip -o no-auto-save
show-group-manager
empty-group
```

### Response

N/A (Command Line Output)

#### Success Response (N/A)

N/A

#### Response Example

N/A
```

--------------------------------

### Command Line Options

Source: https://docs.snipaste.com/changelog_id=fixed-47

This section details the command-line options available for Snipaste.

```APIDOC
## Command Line Options

### Description

This section outlines the various command-line options that can be used to control Snipaste's behavior.

### Options

#### Whiteboard Options
- `whiteboard --color [color] --active-screen`: Customizes whiteboard colors and display on the active screen.

#### Screenshot Options
- `snip -o no-auto-save`: Skips automatic saving of screenshots.

#### Image Group Manager Options
- `show-group-manager`: Opens the Image Group Manager window.
- `empty-group`: Clears the current image group.

#### Other Options
- `General/gpu_acceleration`: Advanced configuration for GPU acceleration.
```

--------------------------------

### Multi-Screen Snipping Support (Mac)

Source: https://docs.snipaste.com/changelog_id=v1102

Details the implementation of multi-screen snipping capabilities for Snipaste on macOS. This feature allows users to capture portions of multiple displays simultaneously, improving productivity on setups with more than one monitor.

```applescript
tell application "Snipaste"
    -- Assuming a command to initiate multi-screen snip
    take multi screen snip
end tell
```

--------------------------------

### Snipaste UI and UX Enhancements

Source: https://docs.snipaste.com/changelog_id=v289-beta-linux

Covers user interface and user experience improvements in Snipaste, such as adapting to different DPIs on multi-screen setups, improving the interface for drawing line strips, and prompting user confirmation for pinning too many images.

```plaintext
Multi-screen DPI adaptation
Improved line strip drawing interface
Confirmation for pinning many images
```

--------------------------------

### Capture Active Window with Shadow and Copy to Clipboard (Snipaste PRO)

Source: https://docs.snipaste.com/command-line-options

Captures the currently active window, including a shadow effect, and copies it to the clipboard. This feature requires the PRO version and is executed silently.

```shell
snip --shadow --active-window -o clipboard
```

--------------------------------

### Command Line Options

Source: https://docs.snipaste.com/changelog_id=fixed-21

This section details the various command-line options available for Snipaste, allowing for automated or customized snipping behavior.

```APIDOC
## Command Line Options

### Whiteboard Customization

Use the `whiteboard` command with options to customize its appearance.

- **Command**: `whiteboard`
- **Parameters**:
  - `--color [color_name]` - Optional - Specifies the color of the whiteboard (e.g., `black`).
  - `--active-screen` - Optional - Ensures the whiteboard only displays on the active screen.

### Screenshot Output Control

Control the automatic saving behavior of screenshots.

- **Command**: `snip`
- **Parameters**:
  - `-o no-auto-save` - Optional - Skips the automatic saving of the screenshot.

### Image Group Management

Manage image groups through the command line.

- **Command**: `show-group-manager`
  - **Description**: Opens the Image Group Manager window.

- **Command**: `empty-group`
  - **Description**: Clears the current image group.

### Other Options

- **Command**: `whiteboard --color black --active-screen`
  - **Description**: Example of using whiteboard with custom color and active screen option.

- **Command**: `snip -o no-auto-save`
  - **Description**: Example of taking a screenshot without auto-saving.

- **Command**: `show-group-manager`
  - **Description**: Opens the Image Group Manager.

- **Command**: `empty-group`
  - **Description**: Clears the current image group.
```

--------------------------------

### Command Line Options for Image Group Management (v2.8)

Source: https://docs.snipaste.com/changelog_id=v181

Provides examples of command-line interfaces for managing image groups within Snipaste. This includes opening the image group manager and clearing the current image group, offering scripting and automation capabilities.

```bash
show-group-manager
empty-group
```

--------------------------------

### Snipaste Command Line Options

Source: https://docs.snipaste.com/changelog_id=%E6%96%B0%E5%A2%9E%EF%BC%9A

This snippet details various command-line options for Snipaste, including options for whiteboard customization, screenshot output control, and managing image groups. These commands allow for programmatic control over Snipaste's behavior. Dependencies are implicit to the Snipaste application itself.

```bash
whiteboard --color black --active-screen
snip -o no-auto-save
show-group-manager
empty-group
```

--------------------------------

### Screenshot Shadow Option Persistence

Source: https://docs.snipaste.com/changelog_id=fixed-43

Explains a fix where the `--shadow` or `--no-shadow` command-line options used at the start of a screenshot no longer incorrectly affect subsequent snipping operations. This ensures consistent behavior regardless of initial shadow settings.

```bash
# Screenshot started with --shadow or --no-shadow would no longer affect subsequent snipping
```

--------------------------------

### Snipaste Windows 11 UI Adaptation and Virtual Desktop Support

Source: https://docs.snipaste.com/changelog_id=v184

This focuses on Snipaste's adaptation to Windows 11, including context menu styling and support for virtual desktops in image windows. It also addresses issues like fixing the 'C' key not typing on remote desktop and element detection for browsers.

```text
Image windows support virtual desktop on Windows 11 #2233
Adapt context menu style for Windows 11
Fix cannot type 'C' on remote desktop #2078
Fix element detection for Firefox in fullscreen mode
Fix element detection in Waterfox #2307
```

--------------------------------

### Screenshot Started with --shadow or --no-shadow No Longer Affect Subsequent Snipping (PRO, v2.7.2)

Source: https://docs.snipaste.com/changelog_id=v181

Ensures that using the `--shadow` or `--no-shadow` command-line options for screenshots does not interfere with subsequent snipping operations. This resolves a behavioral issue related to shadow effects.

```bash
Screenshot started with `--shadow` or `--no-shadow` would no longer affect subsequent snipping
```

--------------------------------

### Snipaste Command Line Options

Source: https://docs.snipaste.com/changelog_id=v221

This section details the command-line options available for Snipaste, including options for whiteboard, screenshot output, and image group management.

```APIDOC
## Command Line Options

### Whiteboard Options

- `whiteboard --color <color>`: Sets the whiteboard color. Example: `whiteboard --color black`
- `whiteboard --active-screen`: Displays the whiteboard only on the active screen.

### Screenshot Options

- `snip -o no-auto-save`: Skips auto-saving of screenshots.

### Image Group Manager Options

- `show-group-manager`: Opens the Image Group Manager window.
- `empty-group`: Clears the current image group.

### Other Options

- (No specific endpoint for general options, but features are described in release notes)

```

--------------------------------

### Snip Options: Define Capture Area

Source: https://docs.snipaste.com/command-line-options_id=examples

Provides examples of using the `snip` command with various options to define the area for screenshots. These include specifying coordinates, size, aspect ratio, fullscreen, last used area, active window, active screen, and a custom dialog.

```bash
snip
snip --area X Y WIDTH HEIGHT
snip --size WIDTH HEIGHT [--keep_aspect_ratio]
snip --full
snip --last
snip --active-window
snip --active-screen
snip --custom
```

--------------------------------

### Configuration Options

Source: https://docs.snipaste.com/changelog_id=improved-6

Details advanced configuration options for Snipaste.

```APIDOC
## Advanced Configs

- `General/gpu_acceleration`
  - Description: Enables or disables GPU acceleration for Snipaste. (Boolean)
```

--------------------------------

### Command Line Option to Clear Snipaste Image Group

Source: https://docs.snipaste.com/changelog_id=fixed-21

This command-line option clears the current image group in Snipaste. This is useful for resetting the current state or starting a new set of image collections programmatically. It does not affect saved image groups but rather the active, temporary collection.

```bash
empty-group
```

--------------------------------

### Snipaste General Improvements and Bug Fixes

Source: https://docs.snipaste.com/changelog_id=v184

This summarizes various general improvements and bug fixes across Snipaste versions. It includes issues like crashes on screen disconnection, lagging sound effects, antialiasing problems, text parsing errors, and enhancements to UI adaptation for different DPIs and multi-screen setups.

```text
Upgrade to Qt 6.2.4
New option: Remember last used image extension #2238
Select the next image group by default for image group switch #2354
Improve interface for different DPIs on multi-screen #2256
Ask user to confirm when there are too many images to pin #2291
When you annotate on an image window and accidentally hide the toolbar, the context menu can help you quit annotation or show the toolbar
Show the failure reason when user is setting the global hotkey and it gets rejected
No more writing frequently changing item `Misc/preload_dlls_last_interval` into config.ini
Fix crash on screen disconnection (e.g. system going into sleeping states) #2208
Fix lagging when playing sound effect after snipping
Fix antialiasing on some annotations
Fix text parsing for color values #2197
Other improvements and bug fixes #2175 #2225 #2243 #2281
Fixed dll error on Windows 7 #2103
Minor bug fix
Fixed Quick Save failure due to illegal characters in foreground window title #2068
Fixed keypad numbers not functional as expected
Fixed crash on AMD Graphics Cards #2056
Fixed blurry tray icon after display DPI change #512
Improved user interface adaptation after diplay DPI change
Prevent border resizing if the cursor is inside the image window #2047
Fixed pinning images copied from chrome browser incorrectly shown as url #2013
Fixed wrong positioning of the painting toolbar for some situations
Prevent color picker showing up in screenshot #1963
Improved Russian translation.
Improved user experience for drawing a line strip
Improved image quality when saving images as JPEG
Other improvements and bug fixes #1961 #2008
Fixed posible application hang when detecting window interface elements
Other minor fixes #1944 #1950
Fixed the color profile of screenshots
Fixed display device detection
Fixed a few bugs
Fixed crash issue on some Intel Graphics cards
Fixed color dialog not showing up #1932
Improved window detection when transparent windows (e.g. LyricsX) are present #1932
```

--------------------------------

### Command Line Options

Source: https://docs.snipaste.com/changelog_id=fixed-8

Snipaste supports various command-line options for controlling its behavior, such as setting whiteboard colors, managing screenshot saving, and opening specific windows.

```APIDOC
## Command Line Options

### Whiteboard Customization

Use the `whiteboard` command with `--color` and `--active-screen` flags to customize the whiteboard.

```
whiteboard --color <color_name> --active-screen
```

*   `--color <color_name>`: Sets the whiteboard color (e.g., `black`).
*   `--active-screen`: Ensures the whiteboard is only displayed on the active screen.

### Screenshot Output Control

Control the auto-save behavior of screenshots using the `-o` flag with the `snip` command.

```
snip -o no-auto-save
```

*   `no-auto-save`: Skips the automatic saving of the screenshot.

### Image Group Management

Commands to manage image groups within Snipaste.

```
show-group-manager
```

*   Opens the Image Group Manager window.

```
empty-group
```

*   Clears the current image group.

### Other Command Line Options

*   `empty-group`: Clears the current image group.
```

--------------------------------

### Command Line Options - Image Group Manager

Source: https://docs.snipaste.com/changelog_id=v225-beta-mac

Open the Image Group Manager window using a command-line argument.

```APIDOC
## Command Line Options - Image Group Manager

### Description
Opens the Snipaste Image Group Manager window.

### Method
Command Line

### Endpoint
`show-group-manager`

### Parameters
This command takes no parameters.

### Request Example
```bash
show-group-manager
```

### Response
#### Success Response (0)
- The Image Group Manager window will be displayed.

#### Response Example
```
(Image Group Manager window opened)
```
```

--------------------------------

### UI and Display Adaptations

Source: https://docs.snipaste.com/changelog_id=v20

This snippet details improvements to Snipaste's user interface and display adaptations, particularly for multi-screen setups and different DPI settings. It also includes changes to context menu styles for Windows 11 and fixes for blurry tray icons after DPI changes. These updates aim for a more consistent and visually accurate experience across various display configurations.

```text
Adapt context menu style for Windows 11
Improve interface for different DPIs on multi-screen #2256
Fixed blurry tray icon after display DPI change #512
Improved user interface adaptation after diplay DPI change
```
Tokens:
Raw