---
name: easy-screenshot
description: Easy Screenshot CLI:免交互矩形截屏、贴图管理、配置读写。安装桌面版(≥0.2.0)后任意终端直接调用,无需其他依赖。
---

# Easy Screenshot CLI

截图(Snip)、标注(Annotate)、贴图(Pin)三位一体的 Windows 桌面工具。**安装桌面版后,任意终端直接使用 `easy-screenshot` 命令**,无需 Node、无需克隆仓库。

## 安装

下载并安装桌面版安装包(**v0.2.0 及以上**含 CLI):

- 安装时会把命令垫片加入用户 PATH(新开的终端立即可用;安装前已开的终端需重开)
- 卸载时会自动从 PATH 移除

## 命令清单

### snip — 免交互矩形截屏

```powershell
# 截取主屏 (100,200) 起 800x600 区域,保存 PNG
easy-screenshot snip --rect 100,200,800,600 --out out.png

# 全屏截图,存 JPG(质量 85)并同时复制到剪贴板
easy-screenshot snip --out full.jpg --format jpg --quality 85 --clipboard

# 只复制到剪贴板(不落盘)
easy-screenshot snip --rect 0,0,1920,1080 --clipboard
```

输出:JSON 一行,`{"ok":true,"width":...,"height":...,"saved":"绝对路径","clipboard":bool}`。

### pin — 把图片钉成置顶贴图

```powershell
easy-screenshot pin C:\path\to\image.png
```

- 有常驻实例时:通知实例用该图创建贴图,命令立即返回
- 无实例时:启动常驻进程显示贴图(关闭贴图窗口即退出)

### unpin — 关闭全部贴图

```powershell
easy-screenshot unpin --all
```

### settings — 配置读写

```powershell
easy-screenshot settings get
easy-screenshot settings set --key output.jpegQuality --value 85
easy-screenshot settings set --key hotkeys.snip --value F2
easy-screenshot settings set --key behavior.launchAtLogin --value true
```

`--value` 按 JSON 解析(失败则按字符串)。可配置路径见 `settings get` 输出结构:hotkeys.{snip,pin,togglePins,toggleClickThrough}、output.{jpegQuality,namingTemplate,quickSaveDir}、behavior.{cancelOnBlur,restorePinCount,historyCount,launchAtLogin}。

## 注意事项

- 坐标 `--rect` 为逻辑像素,基于主显示器左上角
- 交互式截图(F1 全屏选区标注)不属于 CLI:自动化场景用 `snip --rect` 参数化等价完成
- 隐私:截屏内容为屏幕实时画面,自动化批量调用时注意屏上是否有敏感窗口
- 负值参数(如 `--wm-angle -30` 类)若被误认为选项,使用等号语法 `--参数=-30`

## 从源码运行(开发者)

```powershell
git clone <easy_screenshot 仓库> && cd easy_screenshot
npm install && npm run build
npx electron . --cli snip --rect 100,100,800,600 --out out.png
```