feat(config): support .sentryclirc config file for per-directory defaults by BYK · Pull Request #693 · getsentry/cli

BYK · 2026-04-08T18:22:59Z

Summary

Adds backward-compatible .sentryclirc INI config file support, matching the legacy sentry-cli format
Walks up from CWD to find config files, merging them (closest file wins per-field) with ~/.sentryclirc as global fallback
Enables per-directory org/project defaults for monorepos
Token and URL are applied via env shim (SENTRY_AUTH_TOKEN, SENTRY_URL); org/project are inserted directly into the resolution chain with source tracking

Resolution chain (updated)

1. Explicit CLI args          (highest)
2. Environment variables
3. .sentryclirc file          ← NEW
4. SQLite defaults
5. DSN auto-detection
6. Directory name inference   (lowest)

Monorepo example

monorepo/
  .sentryclirc              # [defaults] org = my-company
  packages/
    frontend/.sentryclirc   # [defaults] project = frontend-web
    backend/.sentryclirc    # [defaults] project = backend-api

New files

File	Purpose
`src/lib/ini.ts`	Zero-dep INI parser (BOM, quotes, case-insensitive)
`src/lib/sentryclirc.ts`	Walk-up discovery + merge + env shim + cache
`test/lib/ini.test.ts`	26 unit tests
`test/lib/ini.property.test.ts`	6 property-based tests (fast-check)
`test/lib/sentryclirc.test.ts`	24 unit tests
`test/lib/sentryclirc.property.test.ts`	3 property-based tests

Modified files

src/cli.ts — call applySentryCliRcEnvShim() early in boot
src/lib/resolve-target.ts — insert step 3 in all 4 resolution functions
docs/src/content/docs/configuration.md — new .sentryclirc section with monorepo guide
docs/src/content/docs/features.md — link to resolution priority + tip
docs/src/content/docs/agent-guidance.md — updated auto-detection references
plugins/sentry-cli/skills/sentry-cli/SKILL.md — regenerated

github-actions · 2026-04-08T18:23:26Z

Semver Impact of This PR

🟡 Minor (new features)

📋 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 ✨

(commands) Add buildRouteMap wrapper with standard subcommand aliases by BYK in #690

(config) Support .sentryclirc config file for per-directory defaults by BYK in #693

Bug Fixes 🐛

(dashboard) Render tracemetrics widgets in dashboard view by BYK in #695
(init) Narrow command validation to actual shell injection vectors by betegon in #697
(init,feedback) Default to tracing only in feature select and attach user email to feedback by MathurAditya724 in #688

Internal Changes 🔧

(docs) Gitignore generated command docs, extract fragments by BYK in #696
(eval) Replace OpenAI with Anthropic SDK in init-eval judge by betegon in #683
(init) Use markdown pipeline for spinner messages by betegon in #686
Regenerate skill files and command docs by github-actions[bot] in 584ec0e0

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

github-actions · 2026-04-08T18:23:34Z

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

github-actions · 2026-04-08T18:26:24Z

Codecov Results 📊

✅ 134 passed | Total: 134 | 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 88.42%. Project has 1516 uncovered lines.
❌ Project coverage is 95.38%. Comparing base (base) to head (head).

Files with missing lines (2)

File	Patch %	Lines
src/lib/resolve-target.ts	34.88%	⚠️ 28 Missing
src/lib/sentryclirc.ts	96.35%	⚠️ 5 Missing

Coverage diff

@@            Coverage Diff             @@
##          main       #PR       +/-##
==========================================
- Coverage    95.47%    95.38%    -0.09%
==========================================
  Files          224       227        +3
  Lines        32534     32779      +245
  Branches         0         0         —
==========================================
+ Hits         31059     31263      +204
- Misses        1475      1516       +41
- Partials         0         0         —

Generated by Codecov Action

src/lib/sentryclirc.ts

src/cli.ts

src/lib/resolve-target.ts

src/cli.ts

plugins/sentry-cli/skills/sentry-cli/references/dashboard.md

src/cli.ts

src/lib/sentryclirc.ts

src/cli.ts

src/lib/resolve-target.ts

src/lib/dsn/project-root.ts

cursor

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit 3b880a9. Configure here.}

cursor · 2026-04-09T12:28:39Z

src/lib/dsn/project-root.ts

+  }
+
+  // Populate sentryclirc cache from accumulated data
+  setSentryCliRcCache(resolvedStart, rcConfig);


Cache overwrite drops global fallback config values

Medium Severity

walkUpDirectories accumulates .sentryclirc data via applySentryCliRcDir, which explicitly skips global paths (~/.sentryclirc, $SENTRY_CONFIG_DIR/.sentryclirc) because they're meant to be "applied as fallback after the walk." However, walkUpDirectories never calls applyGlobalFallbacks before calling setSentryCliRcCache, so the cached config is missing global fallback values. This overwrites any correctly-populated cache entry from a prior loadSentryCliRc call (which does call applyGlobalFallbacks in doLoad). The walk may also exit early (on DSN or repo root), further missing ancestor configs.

Additional Locations (1)

src/lib/sentryclirc.ts#L173-L187

^{Reviewed by Cursor Bugbot for commit 3b880a9. Configure here.}

…ults Add backward-compatible support for .sentryclirc INI config files. The CLI walks up from CWD to find config files, merging them (closest wins per-field) with ~/.sentryclirc as a global fallback. Supported fields: - [defaults] org, project, url - [auth] token Token and URL are applied via env shim (SENTRY_AUTH_TOKEN, SENTRY_URL). Org and project are inserted into the resolution chain between env vars and SQLite defaults with source tracking. This enables per-directory project defaults in monorepos and seamless migration from legacy sentry-cli.

sentry · 2026-04-09T12:43:55Z

src/lib/dsn/project-root.ts

-        state.levelsTraversed
-      );
+    if (dsnResult && currentDir !== stopBoundary) {
+      setSentryCliRcCache(resolvedStart, rcConfig);


Bug: The .sentryclirc cache is populated prematurely by walkUpDirectories without global fallbacks, causing loadSentryCliRc to use an incomplete configuration.
_{Severity: HIGH}

Suggested Fix

Delay populating the .sentryclirc cache until after all configuration sources, including global fallbacks, have been fully resolved and merged. Alternatively, ensure that loadSentryCliRc invalidates or ignores the incomplete cache entry created by walkUpDirectories and performs a complete configuration load.

Prompt for AI Agent

Review the code at the location below. A potential bug has been identified by an AI agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's not valid. Location: src/lib/dsn/project-root.ts#L487 Potential issue: The `.sentryclirc` configuration cache is prematurely populated by `walkUpDirectories` with a configuration that omits global fallbacks, such as those from `~/.sentryclirc`. Subsequent calls to `loadSentryCliRc` then access this incomplete cache. This causes global settings like `auth.token` or `defaults.url` to be ignored, which can lead to authentication or connection failures when the CLI attempts to communicate with Sentry.

BYK force-pushed the feat/sentryclirc-config branch 2 times, most recently from 7ca1150 to e0b746c Compare April 8, 2026 19:42

BYK marked this pull request as ready for review April 8, 2026 19:42

sentry bot reviewed Apr 8, 2026

View reviewed changes

src/lib/sentryclirc.ts Show resolved Hide resolved

BYK force-pushed the feat/sentryclirc-config branch from e0b746c to c0ef499 Compare April 8, 2026 20:00

cursor bot reviewed Apr 8, 2026

View reviewed changes

src/lib/sentryclirc.ts Show resolved Hide resolved

sentry bot reviewed Apr 8, 2026

View reviewed changes

src/cli.ts Outdated Show resolved Hide resolved

BYK force-pushed the feat/sentryclirc-config branch from c0ef499 to 8d86cbd Compare April 8, 2026 20:09

cursor bot reviewed Apr 8, 2026

View reviewed changes

src/lib/resolve-target.ts Show resolved Hide resolved

BYK force-pushed the feat/sentryclirc-config branch 2 times, most recently from 465e9f9 to 519dc5f Compare April 9, 2026 09:12

cursor bot reviewed Apr 9, 2026

View reviewed changes

src/cli.ts Outdated Show resolved Hide resolved

BYK force-pushed the feat/sentryclirc-config branch from c2f32be to 05d4dae Compare April 9, 2026 09:26

cursor bot reviewed Apr 9, 2026

View reviewed changes

plugins/sentry-cli/skills/sentry-cli/references/dashboard.md Outdated Show resolved Hide resolved

BYK force-pushed the feat/sentryclirc-config branch from 05d4dae to e141d2f Compare April 9, 2026 09:39

cursor bot reviewed Apr 9, 2026

View reviewed changes

src/cli.ts Outdated Show resolved Hide resolved

sentry bot reviewed Apr 9, 2026

View reviewed changes

src/lib/sentryclirc.ts Show resolved Hide resolved

BYK force-pushed the feat/sentryclirc-config branch from 448efc2 to ae7499c Compare April 9, 2026 09:47

cursor bot reviewed Apr 9, 2026

View reviewed changes

src/lib/sentryclirc.ts Show resolved Hide resolved

BYK force-pushed the feat/sentryclirc-config branch 2 times, most recently from 50670a8 to 9653462 Compare April 9, 2026 10:28

cursor bot reviewed Apr 9, 2026

View reviewed changes

src/cli.ts Show resolved Hide resolved

BYK force-pushed the feat/sentryclirc-config branch from 0a10704 to 6148c3f Compare April 9, 2026 10:44

sentry bot reviewed Apr 9, 2026

View reviewed changes

src/lib/resolve-target.ts Show resolved Hide resolved

BYK force-pushed the feat/sentryclirc-config branch from 1b34396 to 3b880a9 Compare April 9, 2026 12:22

sentry bot reviewed Apr 9, 2026

View reviewed changes

src/lib/dsn/project-root.ts Show resolved Hide resolved

cursor bot reviewed Apr 9, 2026

View reviewed changes

BYK force-pushed the feat/sentryclirc-config branch from 3b880a9 to 496a257 Compare April 9, 2026 12:31

BYK force-pushed the feat/sentryclirc-config branch from 496a257 to dfe7a29 Compare April 9, 2026 12:40

sentry bot reviewed Apr 9, 2026

View reviewed changes

Uh oh!

Conversation

BYK commented Apr 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Resolution chain (updated)

Monorepo example

New files

Modified files

Uh oh!

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

Uh oh!

Semver Impact of This PR

New Features ✨

Bug Fixes 🐛

Internal Changes 🔧

Uh oh!

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

Uh oh!

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

Uh oh!

github-actions bot commented Apr 8, 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot Apr 9, 2026

Choose a reason for hiding this comment

Cache overwrite drops global fallback config values

Uh oh!

sentry bot Apr 9, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

BYK commented Apr 8, 2026 •

edited

Loading

github-actions bot commented Apr 8, 2026 •

edited

Loading

github-actions bot commented Apr 8, 2026 •

edited

Loading

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

github-actions bot commented Apr 8, 2026 •

edited

Loading