Skip to content

feat(cli): Back up the database on upgrade and add cli upgrade undo #1631

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 10 commits into from
Oct 27, 2026
Merged

feat(cli): Back up the database on upgrade and add cli upgrade undo #1631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d2a66ee
feat(cli): Back up the database on upgrade and add `cli upgrade undo`
sentry-junior[bot] Oct 23, 2026
75d5e16
fix(cli): Keep logouts across undo and explain undo on Homebrew
sentry-junior[bot] Oct 23, 2026
7f946ee
ref(cli): Record upgrades in backup file names instead of a manifest
sentry-junior[bot] Oct 27, 2026
fae6db7
fix(cli): Revert the backup and restore when curl setup fails
sentry-junior[bot] Oct 27, 2026
68d9123
fix(cli): Keep the database as is when a hand-off setup fails
sentry-junior[bot] Oct 27, 2026
4483a90
fix(cli): Reinstate the database after a failed undo that needed a ha…
sentry-junior[bot] Oct 27, 2026
07cb5e6
fix(cli): Put this version's database back when a hand-off setup fails
sentry-junior[bot] Oct 27, 2026
db946be
fix(cli): Check backup file types with stat
sentry-junior[bot] Oct 27, 2026
41eac94
fix(cli): Keep undo from overwriting the restored channel or losing t…
sentry-junior[bot] Oct 27, 2026
e4586e5
ref(cli): Remove the database's write-ahead log files in parallel
sentry-junior[bot] Oct 27, 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
6 changes: 6 additions & 0 deletions apps/cli-docs/src/fragments/commands/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ After switching, bare `sentry cli upgrade` will continue tracking that channel.
| `stable` | Latest stable release (default) |
| `nightly` | Built from `main`, updated on every commit |

## Undo an upgrade

Before switching versions, `sentry cli upgrade` saves a copy of the local database for the version it replaces, in `backups/` under the config directory. `sentry cli upgrade undo` reinstalls that version and restores its database. The logins you have now are kept when that version stores them the same way; otherwise the command says so, and you may need to run `sentry auth login`. Other changes since the upgrade, such as defaults, are undone.

One backup is kept per version, up to the five most recent. They contain your credentials, so only your user can read them. Undo only covers version changes made with `sentry cli upgrade`, not ones made through npm or Homebrew directly. Homebrew can't install an earlier version, so on a Homebrew install run `sentry cli upgrade undo --method curl` to return to it as a standalone binary.

## Installation Detection

The CLI detects how it was installed and uses the appropriate upgrade method:
Expand Down
5 changes: 4 additions & 1 deletion packages/cli/plugins/sentry-cli/skills/sentry-cli/references/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ Update the Sentry CLI to the latest version

| Argument | Description |
|----------|-------------|
| `[<version>]` | Specific version (e.g. 0.5.0), or "nightly"/"stable" to switch channel; omit to update within current channel |
| `[<version>]` | Specific version (e.g. 0.5.0), "nightly"/"stable" to switch channel, or "undo" to return to the previous version; omit to update within current channel |

**Flags:**
- `--check - Check for updates without installing`
Expand All @@ -259,6 +259,9 @@ sentry cli upgrade stable
# Install a specific stable version
sentry cli upgrade 0.5.0

# Return to the version before the last upgrade
sentry cli upgrade undo

# Force re-download even if up to date
sentry cli upgrade --force

Expand Down
Loading
Loading