CleanShot X

CleanShot X 是一款 macOS 截图和屏幕录制应用。Protocol Launcher 允许您生成 CleanShot X 的 URL scheme 链接。

使用方式

有两种使用此库的方式：

• 按需导入（On-Demand）：从子路径导入支持 tree-shaking，保持较小的打包体积。
• 完整导入（Full Import）：从根包导入更方便，但会包含所有应用模块。

生产构建建议选择按需导入；快速脚本或演示可以使用完整导入。

选择安装方式

按需加载

推荐使用。生产环境优化。

全量导入

使用便捷。适合快速脚本。

URL 方法

下面的 helper 与 CleanShot 官方 URL Scheme API 保持一致。

All-In-One 模式

On-Demand

import { allInOne } from 'protocol-launcher/cleanshot-x'

const url = allInOne()

const areaUrl = allInOne({
  x: 100,
  y: 120,
  width: 200,
  height: 150,
  display: 1,
})

打开 All-In-One 在指定区域打开 All-In-One

截图

On-Demand

import { captureArea, capturePreviousArea, captureFullscreen, captureWindow, selfTimer, scrollingCapture, pin } from 'protocol-launcher/cleanshot-x'

const captureAreaUrl = captureArea()

const annotateAreaUrl = captureArea({
  action: 'annotate',
})

const regionUrl = captureArea({
  x: 100,
  y: 120,
  width: 200,
  height: 150,
  display: 1,
})

const previousUrl = capturePreviousArea({
  action: 'copy',
})

const fullscreenUrl = captureFullscreen({
  action: 'save',
})

const windowUrl = captureWindow({
  action: 'upload',
})

const timerUrl = selfTimer({
  action: 'pin',
})

const scrollingUrl = scrollingCapture({
  x: 100,
  y: 120,
  width: 200,
  height: 150,
  start: true,
  autoscroll: true,
})

const pinUrl = pin({
  filepath: '/Users/username/Desktop/my screenshot.png',
})

截取区域并标注 截取指定区域 重复上一次截图 截取全屏 截取窗口 启动延时截图 启动滚动截图 固定文件

屏幕录制

On-Demand

import { recordScreen } from 'protocol-launcher/cleanshot-x'

const url = recordScreen()

const areaUrl = recordScreen({
  x: 100,
  y: 120,
  width: 200,
  height: 150,
  display: 1,
})

打开屏幕录制 在指定区域打开屏幕录制

文本识别

On-Demand

import { captureText } from 'protocol-launcher/cleanshot-x'

const url = captureText()

const fileUrl = captureText({
  filepath: '/Users/username/Desktop/my screenshot.png',
})

const areaUrl = captureText({
  x: 100,
  y: 120,
  width: 200,
  height: 150,
  display: 1,
  linebreaks: true,
})

打开文本识别 从文件识别文本 从区域识别文本

标注

On-Demand

import { openAnnotate, openFromClipboard } from 'protocol-launcher/cleanshot-x'

const fileUrl = openAnnotate({
  filepath: '/Users/username/Desktop/my screenshot.png',
})

const clipboardUrl = openFromClipboard()

在标注中打开文件 在标注中打开剪贴板图片

桌面图标

On-Demand

import { toggleDesktopIcons, hideDesktopIcons, showDesktopIcons } from 'protocol-launcher/cleanshot-x'

const toggleUrl = toggleDesktopIcons()

const hideUrl = hideDesktopIcons()

const showUrl = showDesktopIcons()

切换桌面图标 隐藏桌面图标 显示桌面图标

Quick Access Overlay

On-Demand

import { addQuickAccessOverlay } from 'protocol-launcher/cleanshot-x'

const url = addQuickAccessOverlay({
  filepath: '/Users/username/Desktop/my screenshot.png',
})

添加 Quick Access Overlay

历史管理

On-Demand

import { openHistory, restoreRecentlyClosed } from 'protocol-launcher/cleanshot-x'

const historyUrl = openHistory()

const restoreUrl = restoreRecentlyClosed()

打开历史记录 恢复最近关闭项

设置

On-Demand

import { openSettings } from 'protocol-launcher/cleanshot-x'

const url = openSettings()

const tabUrl = openSettings({
  tab: 'recording',
})

打开设置 打开录制设置

官方文档

• CleanShot X URL Scheme API