docs: update credential storage docs and remove stale config.json references by betegon · Pull Request #408 · getsentry/cli

betegon · 2026-03-12T17:19:57Z

Summary

Auth credentials were migrated to SQLite (cli.db) but docs and code comments still referenced ~/.sentry/config.json. This updates everything to match reality:

Rewrites the auth command docs "Credential Storage" section to note that credentials live in cli.db with restricted permissions, and points users to sentry auth token / sentry auth status instead of exposing the internal schema
Updates the configuration page's credential storage section to name cli.db, mention WAL permissions, and link to the auth docs
Removes DB schema details (column/type table), sqlite3 query examples, and "Direct Database Access" subsection — users shouldn't read the DB directly
Removes sqlite3 examples from the SKILL.md agent skill file
Fixes three stale comments/strings in logout.ts, oauth.ts, and dsn/types.ts

Test Plan

bun run typecheck — passes (pre-existing trial module errors only)
bun run lint — clean
bun run test:unit — no new failures
Verified no sqlite3 or schema content remains in docs

🤖 Generated with Claude Code

…erences Auth credentials moved to SQLite (cli.db) but several docs pages and code comments still referenced the old ~/.sentry/config.json file. Rewrites the auth command docs with the actual schema, env var precedence, and external access instructions. Fixes stale comments in logout, oauth, and dsn types. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

github-actions · 2026-03-12T17:20:14Z

Semver Impact of This PR

🟢 Patch (bug fixes)

📋 Changelog Preview

This is how your changes will appear in the changelog.
Entries from this PR are highlighted with a left border (blockquote style).

New Features ✨

Init

Add --team flag to relay team selection to project creation by MathurAditya724 in #403
Enforce canonical feature display order by betegon in #388
Accept multiple delimiter formats for --features flag by betegon in #386
Add git safety checks before wizard modifies files by betegon in #379
Add experimental warning before wizard runs by betegon in #378
Add init command for guided Sentry project setup by betegon in #283

Issue List

Auto-compact when table exceeds terminal height by BYK in #395
Redesign table to match Sentry web UI by BYK in #372

Other

(trial) Auto-prompt for Seer trial + sentry trial list/start commands by BYK in #399
Support SENTRY_HOST as alias for SENTRY_URL by betegon in #409
Add --dry-run flag to mutating commands by BYK in #387
Return-based output with OutputConfig on buildCommand by BYK in #380
Add --fields flag for context-window-friendly JSON output by BYK in #373
Magic @ selectors (@latest, @most_frequent) for issue commands by BYK in #371
Input hardening against agent hallucinations by BYK in #370
Add response caching for read-only API calls by BYK in #330

Bug Fixes 🐛

Init

Remove implementation detail from help text by betegon in #385
Truncate uncommitted file list to first 5 entries by MathurAditya724 in #381

Other

(api) Convert --data to query params for GET requests by BYK in #383
(docs) Remove double borders and fix column alignment on landing page tables by betegon in #369
Show human-friendly names in trial list and surface plan trials by BYK in #412
Add trace ID validation to trace view + UUID dash-stripping by BYK in #375

Documentation 📚

Update credential storage docs and remove stale config.json references by betegon in #408

Internal Changes 🔧

Init

Remove --force flag by betegon in #377
Remove dead determine-pm step label by betegon in #374

Other

(log/list) Convert non-follow paths to return CommandOutput by BYK in #410
Convert list command handlers to return data instead of writing stdout by BYK in #404
Split api-client.ts into focused domain modules by BYK in #405
Migrate non-streaming commands to CommandOutput with markdown rendering by BYK in #398
Convert Tier 2-3 commands to return-based output and consola by BYK in #394
Convert remaining Tier 1 commands to return-based output by BYK in #382
Converge Tier 1 commands to writeOutput helper by BYK in #376

Other

Minify JSON on read and pretty-print on write in init local ops by MathurAditya724 in #396

_{🤖 This preview updates automatically when you update the PR.}

github-actions · 2026-03-12T17:20:28Z

PR Preview Action v1.8.1
🚀 View preview at https://cli.sentry.dev/pr-preview/pr-408/
Built to branch `gh-pages` at 2026-03-13 09:13 UTC. Preview will be ready when the GitHub Pages deployment is complete.

github-actions · 2026-03-12T17:22:25Z

Codecov Results 📊

✅ 104 passed | Total: 104 | Pass Rate: 100% | Execution Time: 0ms

📊 Comparison with Base Branch

Metric	Change
Total Tests	—
Passed Tests	—
Failed Tests	—
Skipped Tests	—

✨ No test changes detected

All tests are passing successfully.

✅ Patch coverage is 100.00%. Project has 697 uncovered lines.
✅ Project coverage is 96.68%. Comparing base (base) to head (head).

Coverage diff

@@            Coverage Diff             @@
##          main       #PR       +/-##
==========================================
+ Coverage    96.68%    96.68%        —%
==========================================
  Files          159       159         —
  Lines        21011     21011         —
  Branches         0         0         —
==========================================
+ Hits         20314     20314         —
- Misses         697       697         —
- Partials         0         0         —

Generated by Codecov Action

Rename "Reading the Token Externally" to "Direct Database Access" and broaden the framing to orient new users on inspecting stored data rather than just extracting a token. Add expires_at query example. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

BYK

We should not be documenting our schema or encouraging people to read the db directly. We already have sentry auth token command for this

Users should use `sentry auth token` and `sentry auth status` instead of querying the database directly. Remove the auth table schema, sqlite3 examples, and direct database access encouragement. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

docs/src/content/docs/commands/auth.md

SENTRY_TOKEN is the new env var (inspired by GITHUB_TOKEN), while SENTRY_AUTH_TOKEN is the legacy one. The label was on the wrong variable. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

chore: regenerate SKILL.md

4cc8fc8

betegon and others added 2 commits March 12, 2026 18:38

chore: regenerate SKILL.md

dc99816

betegon marked this pull request as ready for review March 12, 2026 17:44

betegon requested a review from BYK March 12, 2026 17:44

BYK requested changes Mar 12, 2026

View reviewed changes

betegon requested a review from BYK March 12, 2026 19:43

BYK approved these changes Mar 12, 2026

View reviewed changes

docs/src/content/docs/commands/auth.md Outdated Show resolved Hide resolved

docs: fix "(legacy)" label on env var precedence

40bee07

SENTRY_TOKEN is the new env var (inspired by GITHUB_TOKEN), while SENTRY_AUTH_TOKEN is the legacy one. The label was on the wrong variable. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

betegon enabled auto-merge (squash) March 13, 2026 09:14

betegon merged commit 585b88a into main Mar 13, 2026
23 checks passed

betegon deleted the docs/update-credential-storage-refs branch March 13, 2026 09:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: update credential storage docs and remove stale config.json references#408

docs: update credential storage docs and remove stale config.json references#408
betegon merged 6 commits intomainfrom
docs/update-credential-storage-refs

betegon commented Mar 12, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 12, 2026 •

edited

Loading

New Features ✨

Init

Issue List

Other

Bug Fixes 🐛

Init

Other

Documentation 📚

Internal Changes 🔧

Init

Other

Other

Uh oh!

github-actions bot commented Mar 12, 2026 •

edited

Loading

Built to branch `gh-pages` at 2026-03-13 09:13 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

github-actions bot commented Mar 12, 2026 •

edited

Loading

Uh oh!

BYK left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

betegon commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Test Plan

Uh oh!

github-actions bot commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Semver Impact of This PR

New Features ✨

Init

Issue List

Other

Bug Fixes 🐛

Init

Other

Documentation 📚

Internal Changes 🔧

Init

Other

Other

Uh oh!

github-actions bot commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Built to branch gh-pages at 2026-03-13 09:13 UTC. Preview will be ready when the GitHub Pages deployment is complete.

Uh oh!

github-actions bot commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Results 📊

📊 Comparison with Base Branch

Uh oh!

BYK left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

betegon commented Mar 12, 2026 •

edited

Loading

github-actions bot commented Mar 12, 2026 •

edited

Loading

github-actions bot commented Mar 12, 2026 •

edited

Loading

Built to branch `gh-pages` at 2026-03-13 09:13 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

github-actions bot commented Mar 12, 2026 •

edited

Loading