Skip to content

docs(cli): Correct self-hosted login, upgrade, and dev setup docs - #1541

Merged
betegon merged 1 commit into
mainfrom
docs/cli-docs-accuracy-2026-10-12
Oct 19, 2026
Merged

betegon merged 1 commit into
mainfrom
docs/cli-docs-accuracy-2026-10-12

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

Summary

This fixes CLI docs that no longer match how the CLI behaves. Every change was checked against the implementation in packages/cli.

What changed

  • Self-hosted login: the docs said setting SENTRY_HOST or SENTRY_URL was enough for sentry auth login. In fact the CLI only trusts a self-hosted host when --url is passed, because that's the only thing that registers a login trust anchor. Without it, login is refused. The self-hosted page, the auth fragment and the generated skill reference now say this, and the env-only example is removed. Also fixed the numbering of the OAuth app setup steps.
  • Upgrade and install methods: added yarn to the install-method table and corrected the bun command to bun add -g. Also noted that switching to nightly from a Homebrew install also moves you to a standalone binary. The --method help for sentry cli setup now lists brew, which it already accepted.
  • Installer: documented SENTRY_INIT=1, which runs sentry init right after installing.
  • Agent skills: the --no-agent-skills choice is saved and applies to later upgrades. sentry cli defaults agent-skills on turns installation back on.
  • Configuration: sentry upgrade is now sentry cli upgrade, and the persistent-defaults intro lists every key sentry cli defaults accepts.
  • Contributor docs: the test commands in contributing.md now match the package scripts. DEVELOPMENT.md now describes SENTRY_CLIENT_ID and the packages/cli/.env.local setup correctly. packages/cli/AGENTS.md now has the right relative link, the full generate:docs steps and an up-to-date command directory list.

Validation

  • Ran generate:schema, generate:docs and the sentry-cli-docs build.
  • ci:policy, lint, typecheck and the repo-wide docs:check passed.
  • The test/commands/cli and test/script tests passed.

via bete.

--

View Junior Session [Sentry]

Co-Authored-By: Miguel Betegon <miguel.betegon@sentry.io>
@vercel

vercel Bot commented Oct 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated
sentry-local Skipped Skipped Oct 19, 2026 11:09am UTC

Request Review

@sentry-junior sentry-junior Bot added the CLI Sentry CLI and CLI documentation label Oct 19, 2026
@betegon
betegon marked this pull request as ready for review October 19, 2026 11:14
@github-actions github-actions Bot added the risk: low PR risk score: low label Oct 19, 2026
@betegon
betegon merged commit 233a5cf into main Oct 19, 2026
32 checks passed
@betegon
betegon deleted the docs/cli-docs-accuracy-2026-10-12 branch October 19, 2026 11:22

This branch was previously deployed

1 inactive deployment
Preview — f5703db8 Deployed Oct 19, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLI Sentry CLI and CLI documentation risk: low PR risk score: low

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants