Skip to main content
Bruno can generate a standalone HTML documentation site from any collection. The result is a single HTML file which is a shareable, interactive API reference that you can open in a browser, send to API consumers, or deploy to a static host. No Bruno installation is required to view it. The generated page loads the documentation renderer from Bruno’s CDN, so viewers need network access. Generated HTML Documentation This is a publishing feature, not an authoring one: Bruno builds the site for you from what’s already in your collection as requests, params, headers, auth, scripts, and tests, along with any documentation you’ve written at the collection, folder, and request levels.
The markdown docs you write inside Bruno are what fill out the descriptions in the generated site. The better your written docs, the better the generated output.

What the generated site includes

  • Interactive playground - readers can edit and execute requests live from the docs. Collection scripts run in a Safe Mode sandbox, with auto-generated code samples in cURL, Python, and JavaScript
  • Environment switcher - resolve {{var}} placeholders against any included environment
  • Full-text search - find requests by name, URL, params, or description

Get started

You can generate the same HTML documentation from the desktop app or Bruno CLI:
  1. Generate documentation in the app - create the HTML file from the collection menu, and use the Advanced options to select environments, filter requests by tags, and include or omit the Git repository link
  2. Generate API documentation with Bruno CLI - regenerate docs in scripts, releases, and CI pipelines
  3. CLI documentation options - embed all or selected environments, filter requests by tags, set the output path, and include or omit the Git link
  4. Deploy and share - host the generated file or send it directly
Use bru docs generate when API documentation is stored in Git or deployed by a pipeline. The CLI and desktop app share the same generation implementation, preventing their output from drifting.