@burn0/burn0 0.2.3 → 0.2.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +51 -15
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -128,6 +128,55 @@ resend $0.15 ░░░░░░░░░░░░░░░░░░░
|
|
|
128
128
|
|
|
129
129
|
---
|
|
130
130
|
|
|
131
|
+
## Dashboard — See Everything in One Place
|
|
132
|
+
|
|
133
|
+
The terminal is great for development. But when you want history, trends, and team visibility — connect to the **free dashboard** at [burn0.dev](https://burn0.dev).
|
|
134
|
+
|
|
135
|
+
### Get started in 60 seconds:
|
|
136
|
+
|
|
137
|
+
```bash
|
|
138
|
+
# 1. Sign in with GitHub
|
|
139
|
+
open https://burn0.dev/login
|
|
140
|
+
|
|
141
|
+
# 2. Go to your dashboard and copy your API key
|
|
142
|
+
# Dashboard → API Keys → Create Key
|
|
143
|
+
|
|
144
|
+
# 3. Add the key to your project
|
|
145
|
+
echo 'BURN0_API_KEY=b0_sk_your_key_here' >> .env
|
|
146
|
+
|
|
147
|
+
# 4. Restart your app — costs now sync to the dashboard
|
|
148
|
+
npm run dev
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
That's it. Every API call is now tracked in the dashboard.
|
|
152
|
+
|
|
153
|
+
### What you'll see:
|
|
154
|
+
|
|
155
|
+
| Feature | Description |
|
|
156
|
+
|---|---|
|
|
157
|
+
| **Live Event Feed** | Every API call streams in real-time — service, model, tokens, cost, latency |
|
|
158
|
+
| **Cost Breakdown** | Per-service, per-model cost breakdown with visual charts |
|
|
159
|
+
| **Monthly Projection** | Estimated monthly spend based on your actual usage trends |
|
|
160
|
+
| **Request History** | Full history of every tracked API call, searchable and filterable |
|
|
161
|
+
| **API Key Management** | Create, list, and revoke keys from the dashboard |
|
|
162
|
+
|
|
163
|
+
### How it works:
|
|
164
|
+
|
|
165
|
+
```
|
|
166
|
+
Your app (with BURN0_API_KEY set)
|
|
167
|
+
│
|
|
168
|
+
├─ Costs still appear in your terminal (nothing changes)
|
|
169
|
+
│
|
|
170
|
+
└─ Events also sync to burn0.dev ──→ Dashboard
|
|
171
|
+
│
|
|
172
|
+
├─ Only metadata: service, model, tokens, cost, status, latency
|
|
173
|
+
└─ Never request/response bodies. Never your API keys.
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
> **Privacy**: burn0 never reads your request or response content. Only metadata is synced — service name, model, token counts, cost, status code, and latency. Your API keys and data stay on your machine.
|
|
177
|
+
|
|
178
|
+
---
|
|
179
|
+
|
|
131
180
|
## Feature Attribution
|
|
132
181
|
|
|
133
182
|
Know exactly which feature burns money:
|
|
@@ -243,22 +292,9 @@ Your app starts
|
|
|
243
292
|
| Mode | API Key | What happens |
|
|
244
293
|
|---|---|---|
|
|
245
294
|
| **Local** (default) | No | Costs in terminal + local ledger. Zero network calls to burn0. |
|
|
246
|
-
| **Cloud** (opt-in) | Yes | Same as local + events sync to dashboard for team visibility. |
|
|
247
|
-
|
|
248
|
-
### Cloud Dashboard
|
|
249
|
-
|
|
250
|
-
Connect an API key to see costs in the browser:
|
|
251
|
-
|
|
252
|
-
- **Live event feed** — every API call in real-time via SSE
|
|
253
|
-
- **Cost breakdown** — per service, per model, per day
|
|
254
|
-
- **Monthly projection** — estimated monthly spend based on trends
|
|
255
|
-
- **API key management** — create, list, revoke keys
|
|
295
|
+
| **Cloud** (opt-in) | Yes | Same as local + events sync to [dashboard](https://burn0.dev/dashboard) for full history and team visibility. |
|
|
256
296
|
|
|
257
|
-
|
|
258
|
-
# Sign in with GitHub at burn0.dev
|
|
259
|
-
# Create an API key, then:
|
|
260
|
-
npx burn0 connect
|
|
261
|
-
```
|
|
297
|
+
> **Start local, upgrade when ready.** burn0 works perfectly without an API key. When you want history and dashboards, add a key — it takes 60 seconds. [Get your free API key →](https://burn0.dev/login)
|
|
262
298
|
|
|
263
299
|
---
|
|
264
300
|
|