Bugs & Requests
Getting started
Wire a "Report bug" button into your app in two minutes.
▶
Bugs & Requests in 2 minutes
~2 minutes01 · INSTALL
Add the SDK
Same SDK as flags + translations. No separate package, no separate API key.
$npm i @shipeasy/sdk
02 · WIRE
Configure once, use everywhere
Same shipeasy() boot as the rest of the platform.
$// app/layout.tsx
import { shipeasy } from '@shipeasy/sdk/server';
await shipeasy({ serverKey: process.env.SHIPEASY_SERVER_KEY ?? '' });
03 · REPORT
File a bug from the browser
The overlay posts via /devtools-auth with a short-lived
browser-scoped admin token. The bug shows up in the dashboard
within seconds.
$// Mount the devtools nub once at app boot:
import { init as initDevtools } from '@shipeasy/devtools';
initDevtools();
// Then users press Shift+Alt+B to file a bug — overlay handles
// title, repro steps, screenshot capture, and posting.
04 · REQUEST
Capture a feature request
Other signed-in members of the project see the request in the Feature requests tab and can vote / triage it.
$// Same nub — users press Shift+Alt+R instead of Shift+Alt+B
// for a feature request. The form prompts for title, description,
// and use case (the fields the CLI `feedback features create`
// requires).
05 · TRIAGE
From the CLI
Or use the dashboard. Either way the records live in your project.
$shipeasy ops list --type bug
shipeasy ops list --type feature_request
Where to next
Worked examplesCase studies
"Forward bugs to Slack", "Wire votes to a public roadmap", "Auto-attach session replay".
Read →ReferenceAPI referencePOST /api/admin/bugs, POST /api/admin/feature-requests, listing, status updates.
Every shipeasy feedback … verb.
Was this page helpful?✎ Edit this page