You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix(local): correct misleading docs in run subcommand
Remove the false claim that `sentry local run` auto-starts a server.
The run subcommand is an env-var wrapper — users start the server
separately via `sentry local serve`. Also adds `local` to the
completions property test.
Copy file name to clipboardExpand all lines: docs/src/fragments/commands/local.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
1
2
2
3
-
[Spotlight](https://spotlightjs.com) is "Sentry for Development" — a lightweight local proxy that ingests Sentry envelopes from SDKs running in your dev stack and surfaces them in real time. `sentry local` runs a minimal [Hono](https://hono.dev/) HTTP server that's wire-compatible with Spotlight's protocol, so your existing SDKs and the [Spotlight overlay](https://spotlightjs.com/about/) work without any changes.
3
+
`sentry local` runs a local development server that captures Sentry SDK envelopes from your dev stack and surfaces errors, traces, and logs in real time — right in your terminal. No authentication required.
4
4
5
-
No authentication is required — the server binds to `localhost` by default and is purely a development tool.
5
+
If a server is already running on the port, the command attaches as an SSE consumer instead of starting a duplicate.
6
6
7
7
## Examples
8
8
9
9
```bash
10
10
# Start the server and tail events (default)
11
11
sentry local
12
12
13
-
# Run your app with Spotlight auto-enabled
13
+
# Run your app with the local server auto-enabled
14
14
sentry local run -- npm run dev
15
15
sentry local run -- python manage.py runserver
16
16
@@ -40,7 +40,7 @@ Env vars injected into the child process:
0 commit comments