Documentation
Full guides, API references, and integration recipes are on the way. Here's a sneak peek at what's coming.
Getting started
A 60-second walkthrough of building your first clean report.
Paste raw notes, logs, stack traces, or repro details into the report builder.
Attach screenshots, PDFs, or text logs so Gemini can inspect supporting evidence.
Choose the destination format, then generate, edit, copy, download, or save the report.
Output formats
GitHub, Jira, Linear, QA, Email, Security — differences and when to use each.
Developer formats: GitHub Issue, Jira Ticket, Linear Issue, QA Report, and Email Report.
Security formats: HackerOne, Bugcrowd, Intigriti, YesWeHack, Generic Bug Bounty, VDP, Pentest Finding, and Security Finding.
Markdown formats render as rich previews; Jira and email remain plain text for easier copying.
How generation works
Gemini generation, fallback formatting, severity inference, and attachment analysis.
The browser sends parsed notes and safe attachment payloads to the server route.
The server calls Gemini API when GEMINI_API_KEY is configured.
If Gemini fails, BugReportly falls back to deterministic local templates so reports still generate.
Templates
Pre-fill templates for common bug categories.
Current sample data demonstrates a checkout regression report.
Planned templates include UI regression, API failure, mobile bug, auth issue, and security finding.
Templates will prefill realistic labels while keeping all report content editable.
Security findings policy
Why we keep security reports defensive only.
Security formats are written for defensive disclosure, triage, and remediation.
Reports can include user-provided proof and observations, but should not add weaponization or evasion guidance.
Gemini prompts and local templates both keep security output focused on evidence, impact, and fixes.
Roadmap
What’s coming next — integrations, exports, and deeper evidence handling.
Better provider controls for Gemini model selection and failure visibility.
Direct integrations for GitHub, Jira, Linear, and security platforms.
PDF export, reusable templates, and saved report collections.