feat(snapshots): add upload command#1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BYK merged 5 commits into from
Jul 3, 2026
Merged

feat(snapshots): add upload command #1186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7da85f9
feat(snapshots): add upload command
BYK Jul 3, 2026
035242a
refactor(snapshots): omit Content-Type on objectstore PUT (match refe…
BYK Jul 3, 2026
d592dbd
fix(snapshots): zstd manifest body + self-review fixes
BYK Jul 3, 2026
c24f1e0
refactor(snapshots): extract collectVcs + resolveSelective helpers
BYK Jul 3, 2026
bf53d57
fix(snapshots): resolve upload path vs cwd + objectstore timeouts
BYK Jul 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/content/docs/contributing.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,7 @@ cli/
│ │ ├── release/ # archive, create, delete, deploy, deploys, finalize, list, propose-version, restore, set-commits, view
│ │ ├── replay/ # list, view
│ │ ├── repo/ # list
│ │ ├── snapshots/ # diff, download
│ │ ├── snapshots/ # diff, download, upload
│ │ ├── sourcemap/ # inject, resolve, upload
│ │ ├── span/ # list, view
│ │ ├── team/ # list
Expand Down
16 changes: 16 additions & 0 deletions docs/src/fragments/commands/snapshots.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,15 @@
## Examples

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand All@@ -21,6 +30,13 @@ sentry snapshots download --app-id my-app --output ./baseline/

## Important Notes

- `snapshots upload` scans a folder for PNG/JPEG images (skipping hidden files),
uploads each to Sentry's object store — images already present are skipped by
content hash — and creates a snapshot. **Sentry SaaS only.** A companion
`<image>.json` sidecar adds per-image metadata; `--all-image-file-names`
(or `--all-image-file-names-file`) lists the full suite for selective uploads.
Each image must be at most 40,000,000 pixels. Git metadata is auto-collected
in CI (see `build upload`); a `--pr-number` requires a resolvable base SHA.
- `snapshots diff` compares two local image directories (PNG/JPEG) perceptually
— anti-aliasing aware, with a per-pixel `--threshold` (0.0–1.0) — and writes a
PNG diff mask per changed image. It makes **no network requests**. Use
Expand Down
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
"hono": "^4.12.27",
"http-cache-semantics": "^4.2.0",
"ignore": "^7.0.5",
"image-size": "^2.0.2",
"ink": "^7.1.0",
"ink-spinner": "^5.0.0",
"jpeg-js": "^0.4.4",
Expand Down
1 change: 1 addition & 0 deletions plugins/sentry-cli/skills/sentry-cli/SKILL.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -526,6 +526,7 @@ Manage and compare snapshots

- `sentry snapshots diff <base-dir> <head-dir>` — Compare two directories of snapshot images
- `sentry snapshots download` — Download baseline snapshot images
- `sentry snapshots upload <path>` — Upload snapshots to a project

→ Full flags and examples: `references/snapshots.md`

Expand Down
30 changes: 30 additions & 0 deletions plugins/sentry-cli/skills/sentry-cli/references/snapshots.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -32,9 +32,39 @@ Download baseline snapshot images
- `--branch <value> - Git branch filter (only with --app-id)`
- `-o, --output <value> - Directory for extracted images (default: ./snapshots-base/)`

### `sentry snapshots upload <path>`

Upload snapshots to a project

**Flags:**
- `--app-id <value> - The application identifier`
- `--diff-threshold <value> - Only report an image as changed when its difference exceeds this fraction (0.0–1.0, e.g. 0.01 = 1%)`
- `--selective - This upload contains only a subset of images (removals/renames won't be detected on PRs)`
- `--all-image-file-names <value> - Comma-separated list of all image names in the full suite (for selective uploads; implies --selective)`
- `--all-image-file-names-file <value> - Path to a file listing all image names, one per line (for selective uploads; implies --selective)`
- `--head-sha <value> - VCS commit SHA (defaults to the current commit)`
- `--base-sha <value> - VCS base commit SHA (defaults to the merge-base with the base ref)`
- `--vcs-provider <value> - VCS provider (defaults to the current remote's provider)`
- `--head-repo-name <value> - Head repository name, e.g. owner/repo (defaults to the current)`
- `--base-repo-name <value> - Base repository name, e.g. owner/repo (for forks)`
- `--head-ref <value> - Head branch/reference (defaults to the current branch)`
- `--base-ref <value> - Base branch/reference (defaults to the merge-base tracking ref)`
- `--pr-number <value> - Pull request number (auto-detected in pull_request GitHub Actions runs)`
- `--force-git-metadata - Force collecting git metadata even outside CI (conflicts with --no-git-metadata)`
- `--no-git-metadata - Disable automatic git metadata collection`

**Examples:**

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand Down
10 changes: 10 additions & 0 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion src/commands/snapshots/index.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
/**
* `sentry snapshots` — manage and compare preprod snapshot images.
*
* Exposes `download` and `diff`. `upload` is ported separately (objectstore).
* Exposes `upload`, `download`, and `diff`.
*/

import { buildRouteMap } from "../../lib/route-map.js";
import { diffCommand } from "./diff.js";
import { downloadCommand } from "./download.js";
import { uploadCommand } from "./upload.js";

export const snapshotsRoute = buildRouteMap({
routes: {
diff: diffCommand,
download: downloadCommand,
upload: uploadCommand,
},
docs: {
brief: "Manage and compare snapshots",
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(snapshots): add upload command#1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BYK
merged 5 commits into

from

Jul 3, 2026
 Merged


feat(snapshots): add upload command
#1186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7da85f9

feat(snapshots): add upload command


BYK Jul 3, 2026
035242a

refactor(snapshots): omit Content-Type on objectstore PUT (match refe…


BYK Jul 3, 2026
d592dbd

fix(snapshots): zstd manifest body + self-review fixes


BYK Jul 3, 2026
c24f1e0

refactor(snapshots): extract collectVcs + resolveSelective helpers


BYK Jul 3, 2026
bf53d57

fix(snapshots): resolve upload path vs cwd + objectstore timeouts


BYK Jul 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/src/content/docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,7 @@ cli/
│ │ ├── release/ # archive, create, delete, deploy, deploys, finalize, list, propose-version, restore, set-commits, view
│ │ ├── replay/ # list, view
│ │ ├── repo/ # list
│ │ ├── snapshots/ # diff, download
│ │ ├── snapshots/ # diff, download, upload
│ │ ├── sourcemap/ # inject, resolve, upload
│ │ ├── span/ # list, view
│ │ ├── team/ # list
Expand Down

16 changes: 16 additions & 0 deletions
docs/src/fragments/commands/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,15 @@
## Examples

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand All@@ -21,6 +30,13 @@ sentry snapshots download --app-id my-app --output ./baseline/

## Important Notes

- `snapshots upload` scans a folder for PNG/JPEG images (skipping hidden files),
 uploads each to Sentry's object store — images already present are skipped by
 content hash — and creates a snapshot. **Sentry SaaS only.** A companion
 `<image>.json` sidecar adds per-image metadata; `--all-image-file-names`
 (or `--all-image-file-names-file`) lists the full suite for selective uploads.
 Each image must be at most 40,000,000 pixels. Git metadata is auto-collected
 in CI (see `build upload`); a `--pr-number` requires a resolvable base SHA.
- `snapshots diff` compares two local image directories (PNG/JPEG) perceptually
 — anti-aliasing aware, with a per-pixel `--threshold` (0.0–1.0) — and writes a
 PNG diff mask per changed image. It makes **no network requests**. Use
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
 "hono": "^4.12.27",
 "http-cache-semantics": "^4.2.0",
 "ignore": "^7.0.5",
 "image-size": "^2.0.2",
 "ink": "^7.1.0",
 "ink-spinner": "^5.0.0",
 "jpeg-js": "^0.4.4",
Expand Down

1 change: 1 addition & 0 deletions
plugins/sentry-cli/skills/sentry-cli/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -526,6 +526,7 @@ Manage and compare snapshots

- `sentry snapshots diff <base-dir> <head-dir>` — Compare two directories of snapshot images
- `sentry snapshots download` — Download baseline snapshot images
- `sentry snapshots upload <path>` — Upload snapshots to a project

→ Full flags and examples: `references/snapshots.md`

Expand Down

30 changes: 30 additions & 0 deletions
plugins/sentry-cli/skills/sentry-cli/references/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,9 +32,39 @@ Download baseline snapshot images
- `--branch <value> - Git branch filter (only with --app-id)`
- `-o, --output <value> - Directory for extracted images (default: ./snapshots-base/)`

### `sentry snapshots upload <path>`

Upload snapshots to a project

**Flags:**
- `--app-id <value> - The application identifier`
- `--diff-threshold <value> - Only report an image as changed when its difference exceeds this fraction (0.0–1.0, e.g. 0.01 = 1%)`
- `--selective - This upload contains only a subset of images (removals/renames won't be detected on PRs)`
- `--all-image-file-names <value> - Comma-separated list of all image names in the full suite (for selective uploads; implies --selective)`
- `--all-image-file-names-file <value> - Path to a file listing all image names, one per line (for selective uploads; implies --selective)`
- `--head-sha <value> - VCS commit SHA (defaults to the current commit)`
- `--base-sha <value> - VCS base commit SHA (defaults to the merge-base with the base ref)`
- `--vcs-provider <value> - VCS provider (defaults to the current remote's provider)`
- `--head-repo-name <value> - Head repository name, e.g. owner/repo (defaults to the current)`
- `--base-repo-name <value> - Base repository name, e.g. owner/repo (for forks)`
- `--head-ref <value> - Head branch/reference (defaults to the current branch)`
- `--base-ref <value> - Base branch/reference (defaults to the merge-base tracking ref)`
- `--pr-number <value> - Pull request number (auto-detected in pull_request GitHub Actions runs)`
- `--force-git-metadata - Force collecting git metadata even outside CI (conflicts with --no-git-metadata)`
- `--no-git-metadata - Disable automatic git metadata collection`

**Examples:**

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand Down

10 changes: 10 additions & 0 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
src/commands/snapshots/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
/**
 * `sentry snapshots` — manage and compare preprod snapshot images.
 *
 * Exposes `download` and `diff`. `upload` is ported separately (objectstore).
 * Exposes `upload`, `download`, and `diff`.
 */

import { buildRouteMap } from "../../lib/route-map.js";
import { diffCommand } from "./diff.js";
import { downloadCommand } from "./download.js";
import { uploadCommand } from "./upload.js";

export const snapshotsRoute = buildRouteMap({
 routes: {
 diff: diffCommand,
 download: downloadCommand,
 upload: uploadCommand,
 },
 docs: {
 brief: "Manage and compare snapshots",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(snapshots): add upload command#1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BYK
merged 5 commits into

from

Jul 3, 2026
 Merged


feat(snapshots): add upload command
#1186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7da85f9

feat(snapshots): add upload command


BYK Jul 3, 2026
035242a

refactor(snapshots): omit Content-Type on objectstore PUT (match refe…


BYK Jul 3, 2026
d592dbd

fix(snapshots): zstd manifest body + self-review fixes


BYK Jul 3, 2026
c24f1e0

refactor(snapshots): extract collectVcs + resolveSelective helpers


BYK Jul 3, 2026
bf53d57

fix(snapshots): resolve upload path vs cwd + objectstore timeouts


BYK Jul 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/src/content/docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,7 @@ cli/
│ │ ├── release/ # archive, create, delete, deploy, deploys, finalize, list, propose-version, restore, set-commits, view
│ │ ├── replay/ # list, view
│ │ ├── repo/ # list
│ │ ├── snapshots/ # diff, download
│ │ ├── snapshots/ # diff, download, upload
│ │ ├── sourcemap/ # inject, resolve, upload
│ │ ├── span/ # list, view
│ │ ├── team/ # list
Expand Down

16 changes: 16 additions & 0 deletions
docs/src/fragments/commands/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,15 @@
## Examples

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand All@@ -21,6 +30,13 @@ sentry snapshots download --app-id my-app --output ./baseline/

## Important Notes

- `snapshots upload` scans a folder for PNG/JPEG images (skipping hidden files),
 uploads each to Sentry's object store — images already present are skipped by
 content hash — and creates a snapshot. **Sentry SaaS only.** A companion
 `<image>.json` sidecar adds per-image metadata; `--all-image-file-names`
 (or `--all-image-file-names-file`) lists the full suite for selective uploads.
 Each image must be at most 40,000,000 pixels. Git metadata is auto-collected
 in CI (see `build upload`); a `--pr-number` requires a resolvable base SHA.
- `snapshots diff` compares two local image directories (PNG/JPEG) perceptually
 — anti-aliasing aware, with a per-pixel `--threshold` (0.0–1.0) — and writes a
 PNG diff mask per changed image. It makes **no network requests**. Use
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
 "hono": "^4.12.27",
 "http-cache-semantics": "^4.2.0",
 "ignore": "^7.0.5",
 "image-size": "^2.0.2",
 "ink": "^7.1.0",
 "ink-spinner": "^5.0.0",
 "jpeg-js": "^0.4.4",
Expand Down

1 change: 1 addition & 0 deletions
plugins/sentry-cli/skills/sentry-cli/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -526,6 +526,7 @@ Manage and compare snapshots

- `sentry snapshots diff <base-dir> <head-dir>` — Compare two directories of snapshot images
- `sentry snapshots download` — Download baseline snapshot images
- `sentry snapshots upload <path>` — Upload snapshots to a project

→ Full flags and examples: `references/snapshots.md`

Expand Down

30 changes: 30 additions & 0 deletions
plugins/sentry-cli/skills/sentry-cli/references/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,9 +32,39 @@ Download baseline snapshot images
- `--branch <value> - Git branch filter (only with --app-id)`
- `-o, --output <value> - Directory for extracted images (default: ./snapshots-base/)`

### `sentry snapshots upload <path>`

Upload snapshots to a project

**Flags:**
- `--app-id <value> - The application identifier`
- `--diff-threshold <value> - Only report an image as changed when its difference exceeds this fraction (0.0–1.0, e.g. 0.01 = 1%)`
- `--selective - This upload contains only a subset of images (removals/renames won't be detected on PRs)`
- `--all-image-file-names <value> - Comma-separated list of all image names in the full suite (for selective uploads; implies --selective)`
- `--all-image-file-names-file <value> - Path to a file listing all image names, one per line (for selective uploads; implies --selective)`
- `--head-sha <value> - VCS commit SHA (defaults to the current commit)`
- `--base-sha <value> - VCS base commit SHA (defaults to the merge-base with the base ref)`
- `--vcs-provider <value> - VCS provider (defaults to the current remote's provider)`
- `--head-repo-name <value> - Head repository name, e.g. owner/repo (defaults to the current)`
- `--base-repo-name <value> - Base repository name, e.g. owner/repo (for forks)`
- `--head-ref <value> - Head branch/reference (defaults to the current branch)`
- `--base-ref <value> - Base branch/reference (defaults to the merge-base tracking ref)`
- `--pr-number <value> - Pull request number (auto-detected in pull_request GitHub Actions runs)`
- `--force-git-metadata - Force collecting git metadata even outside CI (conflicts with --no-git-metadata)`
- `--no-git-metadata - Disable automatic git metadata collection`

**Examples:**

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand Down

10 changes: 10 additions & 0 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
src/commands/snapshots/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
/**
 * `sentry snapshots` — manage and compare preprod snapshot images.
 *
 * Exposes `download` and `diff`. `upload` is ported separately (objectstore).
 * Exposes `upload`, `download`, and `diff`.
 */

import { buildRouteMap } from "../../lib/route-map.js";
import { diffCommand } from "./diff.js";
import { downloadCommand } from "./download.js";
import { uploadCommand } from "./upload.js";

export const snapshotsRoute = buildRouteMap({
 routes: {
 diff: diffCommand,
 download: downloadCommand,
 upload: uploadCommand,
 },
 docs: {
 brief: "Manage and compare snapshots",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(snapshots): add upload command#1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BYK
merged 5 commits into

from

Jul 3, 2026
 Merged


feat(snapshots): add upload command
#1186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7da85f9

feat(snapshots): add upload command


BYK Jul 3, 2026
035242a

refactor(snapshots): omit Content-Type on objectstore PUT (match refe…


BYK Jul 3, 2026
d592dbd

fix(snapshots): zstd manifest body + self-review fixes


BYK Jul 3, 2026
c24f1e0

refactor(snapshots): extract collectVcs + resolveSelective helpers


BYK Jul 3, 2026
bf53d57

fix(snapshots): resolve upload path vs cwd + objectstore timeouts


BYK Jul 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/src/content/docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,7 @@ cli/
│ │ ├── release/ # archive, create, delete, deploy, deploys, finalize, list, propose-version, restore, set-commits, view
│ │ ├── replay/ # list, view
│ │ ├── repo/ # list
│ │ ├── snapshots/ # diff, download
│ │ ├── snapshots/ # diff, download, upload
│ │ ├── sourcemap/ # inject, resolve, upload
│ │ ├── span/ # list, view
│ │ ├── team/ # list
Expand Down

16 changes: 16 additions & 0 deletions
docs/src/fragments/commands/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,15 @@
## Examples

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand All@@ -21,6 +30,13 @@ sentry snapshots download --app-id my-app --output ./baseline/

## Important Notes

- `snapshots upload` scans a folder for PNG/JPEG images (skipping hidden files),
 uploads each to Sentry's object store — images already present are skipped by
 content hash — and creates a snapshot. **Sentry SaaS only.** A companion
 `<image>.json` sidecar adds per-image metadata; `--all-image-file-names`
 (or `--all-image-file-names-file`) lists the full suite for selective uploads.
 Each image must be at most 40,000,000 pixels. Git metadata is auto-collected
 in CI (see `build upload`); a `--pr-number` requires a resolvable base SHA.
- `snapshots diff` compares two local image directories (PNG/JPEG) perceptually
 — anti-aliasing aware, with a per-pixel `--threshold` (0.0–1.0) — and writes a
 PNG diff mask per changed image. It makes **no network requests**. Use
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
 "hono": "^4.12.27",
 "http-cache-semantics": "^4.2.0",
 "ignore": "^7.0.5",
 "image-size": "^2.0.2",
 "ink": "^7.1.0",
 "ink-spinner": "^5.0.0",
 "jpeg-js": "^0.4.4",
Expand Down

1 change: 1 addition & 0 deletions
plugins/sentry-cli/skills/sentry-cli/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -526,6 +526,7 @@ Manage and compare snapshots

- `sentry snapshots diff <base-dir> <head-dir>` — Compare two directories of snapshot images
- `sentry snapshots download` — Download baseline snapshot images
- `sentry snapshots upload <path>` — Upload snapshots to a project

→ Full flags and examples: `references/snapshots.md`

Expand Down

30 changes: 30 additions & 0 deletions
plugins/sentry-cli/skills/sentry-cli/references/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,9 +32,39 @@ Download baseline snapshot images
- `--branch <value> - Git branch filter (only with --app-id)`
- `-o, --output <value> - Directory for extracted images (default: ./snapshots-base/)`

### `sentry snapshots upload <path>`

Upload snapshots to a project

**Flags:**
- `--app-id <value> - The application identifier`
- `--diff-threshold <value> - Only report an image as changed when its difference exceeds this fraction (0.0–1.0, e.g. 0.01 = 1%)`
- `--selective - This upload contains only a subset of images (removals/renames won't be detected on PRs)`
- `--all-image-file-names <value> - Comma-separated list of all image names in the full suite (for selective uploads; implies --selective)`
- `--all-image-file-names-file <value> - Path to a file listing all image names, one per line (for selective uploads; implies --selective)`
- `--head-sha <value> - VCS commit SHA (defaults to the current commit)`
- `--base-sha <value> - VCS base commit SHA (defaults to the merge-base with the base ref)`
- `--vcs-provider <value> - VCS provider (defaults to the current remote's provider)`
- `--head-repo-name <value> - Head repository name, e.g. owner/repo (defaults to the current)`
- `--base-repo-name <value> - Base repository name, e.g. owner/repo (for forks)`
- `--head-ref <value> - Head branch/reference (defaults to the current branch)`
- `--base-ref <value> - Base branch/reference (defaults to the merge-base tracking ref)`
- `--pr-number <value> - Pull request number (auto-detected in pull_request GitHub Actions runs)`
- `--force-git-metadata - Force collecting git metadata even outside CI (conflicts with --no-git-metadata)`
- `--no-git-metadata - Disable automatic git metadata collection`

**Examples:**

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand Down

10 changes: 10 additions & 0 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
src/commands/snapshots/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
/**
 * `sentry snapshots` — manage and compare preprod snapshot images.
 *
 * Exposes `download` and `diff`. `upload` is ported separately (objectstore).
 * Exposes `upload`, `download`, and `diff`.
 */

import { buildRouteMap } from "../../lib/route-map.js";
import { diffCommand } from "./diff.js";
import { downloadCommand } from "./download.js";
import { uploadCommand } from "./upload.js";

export const snapshotsRoute = buildRouteMap({
 routes: {
 diff: diffCommand,
 download: downloadCommand,
 upload: uploadCommand,
 },
 docs: {
 brief: "Manage and compare snapshots",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(snapshots): add upload command#1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BYK
merged 5 commits into

from

Jul 3, 2026
 Merged


feat(snapshots): add upload command
#1186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7da85f9

feat(snapshots): add upload command


BYK Jul 3, 2026
035242a

refactor(snapshots): omit Content-Type on objectstore PUT (match refe…


BYK Jul 3, 2026
d592dbd

fix(snapshots): zstd manifest body + self-review fixes


BYK Jul 3, 2026
c24f1e0

refactor(snapshots): extract collectVcs + resolveSelective helpers


BYK Jul 3, 2026
bf53d57

fix(snapshots): resolve upload path vs cwd + objectstore timeouts


BYK Jul 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/src/content/docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,7 @@ cli/
│ │ ├── release/ # archive, create, delete, deploy, deploys, finalize, list, propose-version, restore, set-commits, view
│ │ ├── replay/ # list, view
│ │ ├── repo/ # list
│ │ ├── snapshots/ # diff, download
│ │ ├── snapshots/ # diff, download, upload
│ │ ├── sourcemap/ # inject, resolve, upload
│ │ ├── span/ # list, view
│ │ ├── team/ # list
Expand Down

16 changes: 16 additions & 0 deletions
docs/src/fragments/commands/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,15 @@
## Examples

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand All@@ -21,6 +30,13 @@ sentry snapshots download --app-id my-app --output ./baseline/

## Important Notes

- `snapshots upload` scans a folder for PNG/JPEG images (skipping hidden files),
 uploads each to Sentry's object store — images already present are skipped by
 content hash — and creates a snapshot. **Sentry SaaS only.** A companion
 `<image>.json` sidecar adds per-image metadata; `--all-image-file-names`
 (or `--all-image-file-names-file`) lists the full suite for selective uploads.
 Each image must be at most 40,000,000 pixels. Git metadata is auto-collected
 in CI (see `build upload`); a `--pr-number` requires a resolvable base SHA.
- `snapshots diff` compares two local image directories (PNG/JPEG) perceptually
 — anti-aliasing aware, with a per-pixel `--threshold` (0.0–1.0) — and writes a
 PNG diff mask per changed image. It makes **no network requests**. Use
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
 "hono": "^4.12.27",
 "http-cache-semantics": "^4.2.0",
 "ignore": "^7.0.5",
 "image-size": "^2.0.2",
 "ink": "^7.1.0",
 "ink-spinner": "^5.0.0",
 "jpeg-js": "^0.4.4",
Expand Down

1 change: 1 addition & 0 deletions
plugins/sentry-cli/skills/sentry-cli/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -526,6 +526,7 @@ Manage and compare snapshots

- `sentry snapshots diff <base-dir> <head-dir>` — Compare two directories of snapshot images
- `sentry snapshots download` — Download baseline snapshot images
- `sentry snapshots upload <path>` — Upload snapshots to a project

→ Full flags and examples: `references/snapshots.md`

Expand Down

30 changes: 30 additions & 0 deletions
plugins/sentry-cli/skills/sentry-cli/references/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,9 +32,39 @@ Download baseline snapshot images
- `--branch <value> - Git branch filter (only with --app-id)`
- `-o, --output <value> - Directory for extracted images (default: ./snapshots-base/)`

### `sentry snapshots upload <path>`

Upload snapshots to a project

**Flags:**
- `--app-id <value> - The application identifier`
- `--diff-threshold <value> - Only report an image as changed when its difference exceeds this fraction (0.0–1.0, e.g. 0.01 = 1%)`
- `--selective - This upload contains only a subset of images (removals/renames won't be detected on PRs)`
- `--all-image-file-names <value> - Comma-separated list of all image names in the full suite (for selective uploads; implies --selective)`
- `--all-image-file-names-file <value> - Path to a file listing all image names, one per line (for selective uploads; implies --selective)`
- `--head-sha <value> - VCS commit SHA (defaults to the current commit)`
- `--base-sha <value> - VCS base commit SHA (defaults to the merge-base with the base ref)`
- `--vcs-provider <value> - VCS provider (defaults to the current remote's provider)`
- `--head-repo-name <value> - Head repository name, e.g. owner/repo (defaults to the current)`
- `--base-repo-name <value> - Base repository name, e.g. owner/repo (for forks)`
- `--head-ref <value> - Head branch/reference (defaults to the current branch)`
- `--base-ref <value> - Base branch/reference (defaults to the merge-base tracking ref)`
- `--pr-number <value> - Pull request number (auto-detected in pull_request GitHub Actions runs)`
- `--force-git-metadata - Force collecting git metadata even outside CI (conflicts with --no-git-metadata)`
- `--no-git-metadata - Disable automatic git metadata collection`

**Examples:**

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand Down

10 changes: 10 additions & 0 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
src/commands/snapshots/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
/**
 * `sentry snapshots` — manage and compare preprod snapshot images.
 *
 * Exposes `download` and `diff`. `upload` is ported separately (objectstore).
 * Exposes `upload`, `download`, and `diff`.
 */

import { buildRouteMap } from "../../lib/route-map.js";
import { diffCommand } from "./diff.js";
import { downloadCommand } from "./download.js";
import { uploadCommand } from "./upload.js";

export const snapshotsRoute = buildRouteMap({
 routes: {
 diff: diffCommand,
 download: downloadCommand,
 upload: uploadCommand,
 },
 docs: {
 brief: "Manage and compare snapshots",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(snapshots): add upload command#1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BYK
merged 5 commits into

from

Jul 3, 2026
 Merged


feat(snapshots): add upload command
#1186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7da85f9

feat(snapshots): add upload command


BYK Jul 3, 2026
035242a

refactor(snapshots): omit Content-Type on objectstore PUT (match refe…


BYK Jul 3, 2026
d592dbd

fix(snapshots): zstd manifest body + self-review fixes


BYK Jul 3, 2026
c24f1e0

refactor(snapshots): extract collectVcs + resolveSelective helpers


BYK Jul 3, 2026
bf53d57

fix(snapshots): resolve upload path vs cwd + objectstore timeouts


BYK Jul 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/src/content/docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,7 @@ cli/
│ │ ├── release/ # archive, create, delete, deploy, deploys, finalize, list, propose-version, restore, set-commits, view
│ │ ├── replay/ # list, view
│ │ ├── repo/ # list
│ │ ├── snapshots/ # diff, download
│ │ ├── snapshots/ # diff, download, upload
│ │ ├── sourcemap/ # inject, resolve, upload
│ │ ├── span/ # list, view
│ │ ├── team/ # list
Expand Down

16 changes: 16 additions & 0 deletions
docs/src/fragments/commands/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,15 @@
## Examples

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand All@@ -21,6 +30,13 @@ sentry snapshots download --app-id my-app --output ./baseline/

## Important Notes

- `snapshots upload` scans a folder for PNG/JPEG images (skipping hidden files),
 uploads each to Sentry's object store — images already present are skipped by
 content hash — and creates a snapshot. **Sentry SaaS only.** A companion
 `<image>.json` sidecar adds per-image metadata; `--all-image-file-names`
 (or `--all-image-file-names-file`) lists the full suite for selective uploads.
 Each image must be at most 40,000,000 pixels. Git metadata is auto-collected
 in CI (see `build upload`); a `--pr-number` requires a resolvable base SHA.
- `snapshots diff` compares two local image directories (PNG/JPEG) perceptually
 — anti-aliasing aware, with a per-pixel `--threshold` (0.0–1.0) — and writes a
 PNG diff mask per changed image. It makes **no network requests**. Use
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
 "hono": "^4.12.27",
 "http-cache-semantics": "^4.2.0",
 "ignore": "^7.0.5",
 "image-size": "^2.0.2",
 "ink": "^7.1.0",
 "ink-spinner": "^5.0.0",
 "jpeg-js": "^0.4.4",
Expand Down

1 change: 1 addition & 0 deletions
plugins/sentry-cli/skills/sentry-cli/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -526,6 +526,7 @@ Manage and compare snapshots

- `sentry snapshots diff <base-dir> <head-dir>` — Compare two directories of snapshot images
- `sentry snapshots download` — Download baseline snapshot images
- `sentry snapshots upload <path>` — Upload snapshots to a project

→ Full flags and examples: `references/snapshots.md`

Expand Down

30 changes: 30 additions & 0 deletions
plugins/sentry-cli/skills/sentry-cli/references/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,9 +32,39 @@ Download baseline snapshot images
- `--branch <value> - Git branch filter (only with --app-id)`
- `-o, --output <value> - Directory for extracted images (default: ./snapshots-base/)`

### `sentry snapshots upload <path>`

Upload snapshots to a project

**Flags:**
- `--app-id <value> - The application identifier`
- `--diff-threshold <value> - Only report an image as changed when its difference exceeds this fraction (0.0–1.0, e.g. 0.01 = 1%)`
- `--selective - This upload contains only a subset of images (removals/renames won't be detected on PRs)`
- `--all-image-file-names <value> - Comma-separated list of all image names in the full suite (for selective uploads; implies --selective)`
- `--all-image-file-names-file <value> - Path to a file listing all image names, one per line (for selective uploads; implies --selective)`
- `--head-sha <value> - VCS commit SHA (defaults to the current commit)`
- `--base-sha <value> - VCS base commit SHA (defaults to the merge-base with the base ref)`
- `--vcs-provider <value> - VCS provider (defaults to the current remote's provider)`
- `--head-repo-name <value> - Head repository name, e.g. owner/repo (defaults to the current)`
- `--base-repo-name <value> - Base repository name, e.g. owner/repo (for forks)`
- `--head-ref <value> - Head branch/reference (defaults to the current branch)`
- `--base-ref <value> - Base branch/reference (defaults to the merge-base tracking ref)`
- `--pr-number <value> - Pull request number (auto-detected in pull_request GitHub Actions runs)`
- `--force-git-metadata - Force collecting git metadata even outside CI (conflicts with --no-git-metadata)`
- `--no-git-metadata - Disable automatic git metadata collection`

**Examples:**

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand Down

10 changes: 10 additions & 0 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
src/commands/snapshots/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
/**
 * `sentry snapshots` — manage and compare preprod snapshot images.
 *
 * Exposes `download` and `diff`. `upload` is ported separately (objectstore).
 * Exposes `upload`, `download`, and `diff`.
 */

import { buildRouteMap } from "../../lib/route-map.js";
import { diffCommand } from "./diff.js";
import { downloadCommand } from "./download.js";
import { uploadCommand } from "./upload.js";

export const snapshotsRoute = buildRouteMap({
 routes: {
 diff: diffCommand,
 download: downloadCommand,
 upload: uploadCommand,
 },
 docs: {
 brief: "Manage and compare snapshots",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(snapshots): add upload command#1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BYK
merged 5 commits into

from

Jul 3, 2026
 Merged


feat(snapshots): add upload command
#1186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7da85f9

feat(snapshots): add upload command


BYK Jul 3, 2026
035242a

refactor(snapshots): omit Content-Type on objectstore PUT (match refe…


BYK Jul 3, 2026
d592dbd

fix(snapshots): zstd manifest body + self-review fixes


BYK Jul 3, 2026
c24f1e0

refactor(snapshots): extract collectVcs + resolveSelective helpers


BYK Jul 3, 2026
bf53d57

fix(snapshots): resolve upload path vs cwd + objectstore timeouts


BYK Jul 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/src/content/docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,7 @@ cli/
│ │ ├── release/ # archive, create, delete, deploy, deploys, finalize, list, propose-version, restore, set-commits, view
│ │ ├── replay/ # list, view
│ │ ├── repo/ # list
│ │ ├── snapshots/ # diff, download
│ │ ├── snapshots/ # diff, download, upload
│ │ ├── sourcemap/ # inject, resolve, upload
│ │ ├── span/ # list, view
│ │ ├── team/ # list
Expand Down

16 changes: 16 additions & 0 deletions
docs/src/fragments/commands/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,15 @@
## Examples

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand All@@ -21,6 +30,13 @@ sentry snapshots download --app-id my-app --output ./baseline/

## Important Notes

- `snapshots upload` scans a folder for PNG/JPEG images (skipping hidden files),
 uploads each to Sentry's object store — images already present are skipped by
 content hash — and creates a snapshot. **Sentry SaaS only.** A companion
 `<image>.json` sidecar adds per-image metadata; `--all-image-file-names`
 (or `--all-image-file-names-file`) lists the full suite for selective uploads.
 Each image must be at most 40,000,000 pixels. Git metadata is auto-collected
 in CI (see `build upload`); a `--pr-number` requires a resolvable base SHA.
- `snapshots diff` compares two local image directories (PNG/JPEG) perceptually
 — anti-aliasing aware, with a per-pixel `--threshold` (0.0–1.0) — and writes a
 PNG diff mask per changed image. It makes **no network requests**. Use
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
 "hono": "^4.12.27",
 "http-cache-semantics": "^4.2.0",
 "ignore": "^7.0.5",
 "image-size": "^2.0.2",
 "ink": "^7.1.0",
 "ink-spinner": "^5.0.0",
 "jpeg-js": "^0.4.4",
Expand Down

1 change: 1 addition & 0 deletions
plugins/sentry-cli/skills/sentry-cli/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -526,6 +526,7 @@ Manage and compare snapshots

- `sentry snapshots diff <base-dir> <head-dir>` — Compare two directories of snapshot images
- `sentry snapshots download` — Download baseline snapshot images
- `sentry snapshots upload <path>` — Upload snapshots to a project

→ Full flags and examples: `references/snapshots.md`

Expand Down

30 changes: 30 additions & 0 deletions
plugins/sentry-cli/skills/sentry-cli/references/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,9 +32,39 @@ Download baseline snapshot images
- `--branch <value> - Git branch filter (only with --app-id)`
- `-o, --output <value> - Directory for extracted images (default: ./snapshots-base/)`

### `sentry snapshots upload <path>`

Upload snapshots to a project

**Flags:**
- `--app-id <value> - The application identifier`
- `--diff-threshold <value> - Only report an image as changed when its difference exceeds this fraction (0.0–1.0, e.g. 0.01 = 1%)`
- `--selective - This upload contains only a subset of images (removals/renames won't be detected on PRs)`
- `--all-image-file-names <value> - Comma-separated list of all image names in the full suite (for selective uploads; implies --selective)`
- `--all-image-file-names-file <value> - Path to a file listing all image names, one per line (for selective uploads; implies --selective)`
- `--head-sha <value> - VCS commit SHA (defaults to the current commit)`
- `--base-sha <value> - VCS base commit SHA (defaults to the merge-base with the base ref)`
- `--vcs-provider <value> - VCS provider (defaults to the current remote's provider)`
- `--head-repo-name <value> - Head repository name, e.g. owner/repo (defaults to the current)`
- `--base-repo-name <value> - Base repository name, e.g. owner/repo (for forks)`
- `--head-ref <value> - Head branch/reference (defaults to the current branch)`
- `--base-ref <value> - Base branch/reference (defaults to the merge-base tracking ref)`
- `--pr-number <value> - Pull request number (auto-detected in pull_request GitHub Actions runs)`
- `--force-git-metadata - Force collecting git metadata even outside CI (conflicts with --no-git-metadata)`
- `--no-git-metadata - Disable automatic git metadata collection`

**Examples:**

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand Down

10 changes: 10 additions & 0 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
src/commands/snapshots/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
/**
 * `sentry snapshots` — manage and compare preprod snapshot images.
 *
 * Exposes `download` and `diff`. `upload` is ported separately (objectstore).
 * Exposes `upload`, `download`, and `diff`.
 */

import { buildRouteMap } from "../../lib/route-map.js";
import { diffCommand } from "./diff.js";
import { downloadCommand } from "./download.js";
import { uploadCommand } from "./upload.js";

export const snapshotsRoute = buildRouteMap({
 routes: {
 diff: diffCommand,
 download: downloadCommand,
 upload: uploadCommand,
 },
 docs: {
 brief: "Manage and compare snapshots",
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(snapshots): add upload command#1186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

BYK
merged 5 commits into

from

Jul 3, 2026
 Merged


feat(snapshots): add upload command
#1186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
7da85f9

feat(snapshots): add upload command


BYK Jul 3, 2026
035242a

refactor(snapshots): omit Content-Type on objectstore PUT (match refe…


BYK Jul 3, 2026
d592dbd

fix(snapshots): zstd manifest body + self-review fixes


BYK Jul 3, 2026
c24f1e0

refactor(snapshots): extract collectVcs + resolveSelective helpers


BYK Jul 3, 2026
bf53d57

fix(snapshots): resolve upload path vs cwd + objectstore timeouts


BYK Jul 3, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


2 changes: 1 addition & 1 deletion
docs/src/content/docs/contributing.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -71,7 +71,7 @@ cli/
│ │ ├── release/ # archive, create, delete, deploy, deploys, finalize, list, propose-version, restore, set-commits, view
│ │ ├── replay/ # list, view
│ │ ├── repo/ # list
│ │ ├── snapshots/ # diff, download
│ │ ├── snapshots/ # diff, download, upload
│ │ ├── sourcemap/ # inject, resolve, upload
│ │ ├── span/ # list, view
│ │ ├── team/ # list
Expand Down

16 changes: 16 additions & 0 deletions
docs/src/fragments/commands/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,15 @@
## Examples

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand All@@ -21,6 +30,13 @@ sentry snapshots download --app-id my-app --output ./baseline/

## Important Notes

- `snapshots upload` scans a folder for PNG/JPEG images (skipping hidden files),
 uploads each to Sentry's object store — images already present are skipped by
 content hash — and creates a snapshot. **Sentry SaaS only.** A companion
 `<image>.json` sidecar adds per-image metadata; `--all-image-file-names`
 (or `--all-image-file-names-file`) lists the full suite for selective uploads.
 Each image must be at most 40,000,000 pixels. Git metadata is auto-collected
 in CI (see `build upload`); a `--pr-number` requires a resolvable base SHA.
- `snapshots diff` compares two local image directories (PNG/JPEG) perceptually
 — anti-aliasing aware, with a per-pixel `--threshold` (0.0–1.0) — and writes a
 PNG diff mask per changed image. It makes **no network requests**. Use
Expand Down

1 change: 1 addition & 0 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -38,6 +38,7 @@
 "hono": "^4.12.27",
 "http-cache-semantics": "^4.2.0",
 "ignore": "^7.0.5",
 "image-size": "^2.0.2",
 "ink": "^7.1.0",
 "ink-spinner": "^5.0.0",
 "jpeg-js": "^0.4.4",
Expand Down

1 change: 1 addition & 0 deletions
plugins/sentry-cli/skills/sentry-cli/SKILL.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -526,6 +526,7 @@ Manage and compare snapshots

- `sentry snapshots diff <base-dir> <head-dir>` — Compare two directories of snapshot images
- `sentry snapshots download` — Download baseline snapshot images
- `sentry snapshots upload <path>` — Upload snapshots to a project

→ Full flags and examples: `references/snapshots.md`

Expand Down

30 changes: 30 additions & 0 deletions
plugins/sentry-cli/skills/sentry-cli/references/snapshots.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -32,9 +32,39 @@ Download baseline snapshot images
- `--branch <value> - Git branch filter (only with --app-id)`
- `-o, --output <value> - Directory for extracted images (default: ./snapshots-base/)`

### `sentry snapshots upload <path>`

Upload snapshots to a project

**Flags:**
- `--app-id <value> - The application identifier`
- `--diff-threshold <value> - Only report an image as changed when its difference exceeds this fraction (0.0–1.0, e.g. 0.01 = 1%)`
- `--selective - This upload contains only a subset of images (removals/renames won't be detected on PRs)`
- `--all-image-file-names <value> - Comma-separated list of all image names in the full suite (for selective uploads; implies --selective)`
- `--all-image-file-names-file <value> - Path to a file listing all image names, one per line (for selective uploads; implies --selective)`
- `--head-sha <value> - VCS commit SHA (defaults to the current commit)`
- `--base-sha <value> - VCS base commit SHA (defaults to the merge-base with the base ref)`
- `--vcs-provider <value> - VCS provider (defaults to the current remote's provider)`
- `--head-repo-name <value> - Head repository name, e.g. owner/repo (defaults to the current)`
- `--base-repo-name <value> - Base repository name, e.g. owner/repo (for forks)`
- `--head-ref <value> - Head branch/reference (defaults to the current branch)`
- `--base-ref <value> - Base branch/reference (defaults to the merge-base tracking ref)`
- `--pr-number <value> - Pull request number (auto-detected in pull_request GitHub Actions runs)`
- `--force-git-metadata - Force collecting git metadata even outside CI (conflicts with --no-git-metadata)`
- `--no-git-metadata - Disable automatic git metadata collection`

**Examples:**

```bash
# Upload a folder of screenshots as a snapshot for an app
sentry snapshots upload ./screenshots --app-id com.example.app

# Upload only a subset of images (removals/renames not inferred on PRs)
sentry snapshots upload ./screenshots --app-id my-app --selective

# Only flag images that differ by more than 1%
sentry snapshots upload ./screenshots --app-id my-app --diff-threshold 0.01

# Compare two directories of snapshot images locally
sentry snapshots diff ./baseline ./head

Expand Down

10 changes: 10 additions & 0 deletions
pnpm-lock.yaml

View file


Open in desktop


Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.


4 changes: 3 additions & 1 deletion
src/commands/snapshots/index.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,17 +1,19 @@
/**
 * `sentry snapshots` — manage and compare preprod snapshot images.
 *
 * Exposes `download` and `diff`. `upload` is ported separately (objectstore).
 * Exposes `upload`, `download`, and `diff`.
 */

import { buildRouteMap } from "../../lib/route-map.js";
import { diffCommand } from "./diff.js";
import { downloadCommand } from "./download.js";
import { uploadCommand } from "./upload.js";

export const snapshotsRoute = buildRouteMap({
 routes: {
 diff: diffCommand,
 download: downloadCommand,
 upload: uploadCommand,
 },
 docs: {
 brief: "Manage and compare snapshots",
Expand Down
Loading
Loading