Skip to content
DocsGitHub

docs

Search and query current Sentry documentation

Find Sentry documentation pages by keyword

Arguments:

Argument Description
<keywords...> Documentation keywords

Options:

Option Description
-n, --limit <limit> Maximum matches to return (1-20) (default: "8")

Examples:

Terminal window
# Search the documentation index
sentry docs list "source maps"
# Limit the number of results
sentry docs list "session replay privacy" --limit 5
# Output as JSON
sentry docs list "source maps" --json

Ask a cited question about Sentry documentation

Arguments:

Argument Description
<question...> Natural-language docs question

Examples:

Terminal window
# Ask a documentation question
sentry docs "How do I configure tracing in Next.js?"
# Use the explicit subcommand
sentry docs query "How do I upload source maps?"
# Use the search alias
sentry docs search "How does session replay mask text?"
# Output the answer as JSON
sentry docs "How do I configure tracing?" --json

All commands support --json for machine-readable output and --fields to select specific JSON fields.

sentry docs answers include inline links and a Sources section containing the Sentry documentation pages used to answer the question. Use sentry docs list to search the documentation index instead; --limit restricts the number of results and --json returns structured output.