stripe-docs

stripe docs [path] [options]stripe docs api identifier [options]stripe docs search query [options]stripe docs prefs list | set id value | unset id

stripe docs is a subcommand of the Stripe CLI. It fetches pages from `docs.stripe.com`, renders them as markdown in the terminal, and can search the site or jump into the API reference by resource, HTTP path, or webhook event name.On a TTY it opens an interactive browser (Bubble Tea TUI) unless --non-interactive or --no-pager is set. Otherwise it pipes the rendered page through a pager. Full `https://docs.stripe.com/...` URLs are accepted and reduced to path, query, and fragment.Authenticated requests reuse credentials from stripe login. Pages may be cached under the CLI config directory. Preferences such as code-snippet language are stored locally and applied when a page is rendered.

path

Path or `docs.stripe.com` URL of a page to fetch, for example `/payments` or `/api/customers`. A leading `/` is added when missing.

Resolve Stripe API reference by resource name (`product`), HTTP method and path (`GET /v1/products`), or event type (`charge.succeeded`).

Search `docs.stripe.com`. Multiple arguments are joined into one query.

List documentation preferences and their allowed values (for example snippet language).

Store a preference, e.g. `stripe docs prefs set server go`.

Drop a stored preference and revert to the default.

Write rendered markdown to stdout instead of a pager. Default on when the CLI detects an AI agent.

Skip the interactive terminal browser and print the page. Default on when the CLI detects an AI agent.

Requires the stripe binary. A network connection to Stripe is required to fetch and search pages.stripe docs api fails with a not-found error when the locator cannot match the identifier. stripe docs search requires a query argument.When stdout is not a terminal, or an AI agent is detected, the TUI is skipped and output is written for piping or capture.

The Stripe CLI was released by Stripe in 2019. The docs command was added later so developers and agents can read `docs.stripe.com` without leaving the terminal.

stripe(1), stripe-listen(1), stripe-logs(1)

Documentation · Homepage · Source code