SnapStep 📸
按一次快捷键，把你的操作变成图文教程。 Record your screen, get a step-by-step guide — automatically.
| 生成的 HTML 教程 | 导出的 Markdown |
|---|---|
 |
 |
SnapStep 在后台监听你的鼠标和键盘：每次点击自动截图并标记位置，输入的文本自动记录。 停止录制后，一份带序号截图的图文教程就生成好了 —— 支持 Markdown / HTML / Word， 可选接入大模型把文案写得更自然。开源版 Scribe / Tango 平替，数据完全保存在本地。
✨ 特性
- 一键录制：系统托盘常驻，全局快捷键（默认
Ctrl+Alt+S）随时开始/停止 - 自动截屏标注：点击处自动画高亮圈 + 步骤序号，输入的文本自动记进步骤里
- 三种导出：Markdown（贴 wiki/仓库）、HTML（单文件内嵌截图，直接发人）、Word（正式文档）
- AI 文案（可选）：填一个 OpenAI 兼容 API 即可让大模型写标题和步骤描述， 预设支持 GLM / DeepSeek / OpenAI，本地模型（Ollama / LM Studio）也行
- 零配置可用：不配 AI 也能用，本地模板自动生成每步文案
- 隐私优先：本机处理，无任何遥测；隐私模式一键停止截屏；密码框输入自动隐藏（尽力检测）
📦 安装
Windows（推荐）：从 Releases 下载 SnapStep.exe，双击即用。
pip：
pip install snapstep # PyPI 正式包
pip install git+https://github.com/Felixssss-106/snapstep.git # 或直接从源码安装
snapstep # 启动托盘 GUI
从源码：
git clone https://github.com/Felixssss-106/snapstep.git
cd snapstep
pip install -e ".[dev]"
pytest # 跑测试
🚀 快速开始
托盘 GUI（默认）
启动后托盘出现图标：
- 按
Ctrl+Alt+S（或托盘菜单「开始录制」） - 像平常一样操作 —— 每次左键点击自动成为一步
- 再按
Ctrl+Alt+S停止，教程自动导出并弹窗提示
右键托盘图标可打开会话文件夹、重新导出、修改设置。
命令行
snapstep record # 录制，回车结束，自动导出
snapstep record --format md --no-ai # 指定格式、跳过 AI
snapstep export ~/.snapstep/sessions/20260912-101010 -f all # 导出已有会话
snapstep config set api.base_url https://api.deepseek.com/v1 # 命令行改配置
snapstep demo # 不录制，直接生成一份示例教程验证安装
🤖 AI 文案配置
设置界面选预设填 API Key 即可；也可命令行：
snapstep config set api.base_url https://open.bigmodel.cn/api/paas/v4
snapstep config set api.model glm-4-flash
snapstep config set api.api_key 你的key
| 预设 | Base URL | 模型示例 |
|---|---|---|
| GLM 智谱 | https://open.bigmodel.cn/api/paas/v4 |
glm-4-flash |
| DeepSeek | https://api.deepseek.com/v1 |
deepseek-chat |
| OpenAI | https://api.openai.com/v1 |
gpt-4o-mini |
| 本地模型 | http://127.0.0.1:11434/v1 |
Ollama / LM Studio 任意模型 |
不配置或调用失败时自动退回本地模板文案，教程永远能生成。
🔒 隐私设计
- 截图、文案、导出全部在本机完成；只有你主动配置了 AI 才会把操作文字摘要发给该 API
- 「隐私模式」：完全不截屏，只记录步骤文字
- 「密码隐藏」：通过 Windows UI Automation 尽力识别密码框，其中的键入以
••••代替 - API 端点仅允许 http/https，并阻止云元数据地址与重定向，防止密钥被转发
- 配置与数据都在
~/.snapstep/，删掉目录即彻底清除
🆚 与在线 SaaS 工具对比
| SnapStep | Scribe / Tango | |
|---|---|---|
| 价格 | 免费开源（MIT） | 免费档限步数，完整功能按席位付费 |
| 数据 | 全程本机 | 操作录屏上传云端 |
| 离线 | 完全可用（无 AI 模式） | 不可用 |
| 导出 | Markdown / HTML / Word | 受付费档限制 |
| AI | 自带 key，任意 OpenAI 兼容模型 | 内置不可换 |
| 平台 | Windows（macOS 在路线图） | 浏览器扩展 |
🗺 Roadmap
- 录屏讲解语音 → 自动转写进步骤文案（ASR）
- AI 视觉模型读懂截图，写出更准确的按钮/控件描述
- 敏感信息智能打码（手机号/邮箱/头像区域）
- PDF 导出、团队模板
- macOS 支持
注意：软件可能存在问题
V0.1.0版本已知问题：快捷键无法使用，截屏延迟不合适，v0.2.0已修复（v0.1.0已废弃）； 自动过滤无效点击功能可能会漏记录，目前正在修复
欢迎按 issues 提需求。
🧪 开发
pip install -e ".[dev]"
pytest # 测试
ruff check src tests scripts # lint
python scripts/make_icon.py # 重新生成图标
pyinstaller snapstep.spec # 本地打包 exe
架构速览：recorder.py（pynput 钩子 + 事件聚合）→ capture.py（mss 截屏 + Pillow 标注）
→ writer.py（AI/模板双路文案）→ export/（md/html/docx）。核心逻辑不依赖输入钩子，纯逻辑可单测。
🤝 贡献
Issue / PR 都欢迎。提交前请跑通 pytest 和 ruff check。
License
MIT See the Chinese sections above for full docs — the UI is Chinese-first, and English UI is on the roadmap. English issues/PRs are welcome!
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file snapstep-0.2.2.tar.gz.
File metadata
- Download URL: snapstep-0.2.2.tar.gz
- Upload date:
- Size: 56.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8c66b960d54bb8b39c53973cef41b188aa674b5256f249f5e70f47c50cdfd063
|
|
| MD5 |
70d92d2c86b9fc5f84fe043a35be06c6
|
|
| BLAKE2b-256 |
a92b25fae1fae0ec68709d5746d7f69cb177efe77f7e3751a4565b9055da6799
|
Provenance
The following attestation bundles were made for snapstep-0.2.2.tar.gz:
Publisher:
publish.yml on Felixssss-106/snapstep
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
snapstep-0.2.2.tar.gz -
Subject digest:
8c66b960d54bb8b39c53973cef41b188aa674b5256f249f5e70f47c50cdfd063 - Sigstore transparency entry: 2806627871
- Sigstore integration time:
-
Permalink:
Felixssss-106/snapstep@fed5fd4dc7765b55690f3961a649c66607935d9a -
Branch / Tag:
refs/tags/v0.2.2 - Owner: https://github.com/Felixssss-106
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@fed5fd4dc7765b55690f3961a649c66607935d9a -
Trigger Event:
push
-
Statement type:
File details
Details for the file snapstep-0.2.2-py3-none-any.whl.
File metadata
- Download URL: snapstep-0.2.2-py3-none-any.whl
- Upload date:
- Size: 53.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
80630c9a5fb246e9a0a4d586ed5d092c1ed722ac924ee2d7d353d0cb18ad4bd3
|
|
| MD5 |
93b0447a30d7b8702198ccbf7b4822e6
|
|
| BLAKE2b-256 |
fac39f7b2cf10ff4dce486ceef0ff9201436ae9fa16f2fcc46452bcf5e10f508
|
Provenance
The following attestation bundles were made for snapstep-0.2.2-py3-none-any.whl:
Publisher:
publish.yml on Felixssss-106/snapstep
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
snapstep-0.2.2-py3-none-any.whl -
Subject digest:
80630c9a5fb246e9a0a4d586ed5d092c1ed722ac924ee2d7d353d0cb18ad4bd3 - Sigstore transparency entry: 2806627973
- Sigstore integration time:
-
Permalink:
Felixssss-106/snapstep@fed5fd4dc7765b55690f3961a649c66607935d9a -
Branch / Tag:
refs/tags/v0.2.2 - Owner: https://github.com/Felixssss-106
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@fed5fd4dc7765b55690f3961a649c66607935d9a -
Trigger Event:
push
-
Statement type:
