mirror of
https://github.com/AgentSeal/codeburn.git
synced 2026-07-31 03:44:59 +00:00
cec61e3b30
- docs/sync/README.md: setup, push, status, logout, reset; privacy guarantees; FAQ - docs/sync/DEVELOPER.md: architecture, discovery/OTLP protocol, sent-ledger design rationale, partial-success and rate-limiting semantics, server contract, testing guide - README.md: sync command group listed under Commands (preview label) AI-Origin: human
130 lines
4.1 KiB
Markdown
130 lines
4.1 KiB
Markdown
# codeburn sync
|
||
|
||
Push your AI usage telemetry to a shared backend so teams can track adoption, budgets, and ROI across developers.
|
||
|
||
Everything stays local-first: codeburn never sends data without your explicit action, and prompts/code are never included.
|
||
|
||
## Quick Start
|
||
|
||
```bash
|
||
# One-time setup (opens browser for login)
|
||
codeburn sync setup https://metrics.your-team.com
|
||
|
||
# Push recent usage
|
||
codeburn sync push
|
||
|
||
# Check status
|
||
codeburn sync status
|
||
```
|
||
|
||
## Commands
|
||
|
||
### `codeburn sync setup <url>`
|
||
|
||
Configures sync with a remote endpoint. Opens your browser for a one-time OIDC login.
|
||
|
||
```bash
|
||
codeburn sync setup https://metrics.your-team.com
|
||
```
|
||
|
||
What happens:
|
||
1. Fetches server configuration from `<url>/.well-known/codeburn-export.json`
|
||
2. Opens your browser to the identity provider's login page
|
||
3. After login, stores a refresh token securely in your OS keychain
|
||
4. Saves the endpoint configuration (no secrets) to `~/.config/codeburn/sync.json`
|
||
|
||
You only need to do this once. The token refreshes silently on every push.
|
||
|
||
### `codeburn sync push`
|
||
|
||
Sends unsent AI usage data to the configured endpoint.
|
||
|
||
```bash
|
||
# Push unsent calls from the last 7 days (default)
|
||
codeburn sync push
|
||
|
||
# Push a larger window
|
||
codeburn sync push --since 30d
|
||
|
||
# Preview what would be sent
|
||
codeburn sync push --dry-run
|
||
```
|
||
|
||
### `codeburn sync status`
|
||
|
||
Shows the current sync configuration and authentication state.
|
||
|
||
```
|
||
Endpoint: https://metrics.your-team.com
|
||
Traces path: /v1/traces
|
||
Issuer: https://auth.your-team.com
|
||
Auth: configured
|
||
Token storage: keychain
|
||
Last sync: 2h ago
|
||
```
|
||
|
||
### `codeburn sync logout`
|
||
|
||
Removes stored credentials and revokes the token at the identity provider.
|
||
|
||
```bash
|
||
codeburn sync logout
|
||
```
|
||
|
||
### `codeburn sync reset --confirm`
|
||
|
||
Clears the sent-ledger, causing the next push to re-send all data in the window. Use after a backend migration or if you suspect missing data.
|
||
|
||
```bash
|
||
codeburn sync reset --confirm
|
||
```
|
||
|
||
## What Gets Sent
|
||
|
||
Each AI interaction becomes one OTLP span with these attributes:
|
||
|
||
| Field | Example | Description |
|
||
|---|---|---|
|
||
| `ai.provider` | `kiro`, `cursor`, `claude` | Which AI tool |
|
||
| `ai.model` | `claude-sonnet-4-6` | Model used |
|
||
| `ai.input_tokens` | `12500` | Prompt tokens |
|
||
| `ai.output_tokens` | `3200` | Response tokens |
|
||
| `ai.cost_usd` | `0.085` | Estimated cost |
|
||
| `ai.project` | `my-app` | Project name |
|
||
| `ai.tools` | `["Edit", "Bash"]` | Tools invoked |
|
||
|
||
A pseudonymous `device_id` distinguishes your machines without revealing hostnames.
|
||
|
||
### What is NOT sent
|
||
|
||
- **Prompts** — your actual messages to AI are never included
|
||
- **Code** — file contents, diffs, and paths stay local
|
||
- **Bash commands** — may contain secrets, never sent
|
||
- **Your name/email** — identity is derived server-side from your login token
|
||
|
||
There is no flag to override this. Privacy is structural, not configurable.
|
||
|
||
## Authentication
|
||
|
||
Sync uses standard OIDC (the same protocol as "Sign in with Google"). Your team's admin sets up the identity provider — you just click through the browser login once.
|
||
|
||
- **Token storage**: macOS Keychain, Windows Credential Manager, or Linux libsecret. Falls back to a `0600` file if no keychain is available.
|
||
- **Token lifetime**: typically 30–90 days (set by your admin). You'll be prompted to re-login when it expires.
|
||
- **Re-login**: run `codeburn sync setup <url>` again.
|
||
|
||
## FAQ
|
||
|
||
**Q: Does sync run automatically?**
|
||
A: No. You run `codeburn sync push` when you want. A future version may offer opportunistic push (after each `codeburn report`), but it's always explicit.
|
||
|
||
**Q: What if I push the same data twice?**
|
||
A: Safe. A local sent-ledger tracks what's been sent. Re-pushing the same window doesn't create duplicates.
|
||
|
||
**Q: What if I'm offline for a week?**
|
||
A: Next push catches up. The default window is 7 days; use `--since 30d` or `--since all` (up to 6 months) for longer gaps. A push runs to completion regardless of size — server rate limits (429) are waited out automatically.
|
||
|
||
**Q: Can my admin see my prompts?**
|
||
A: No. Prompts are never included in the payload. The server only sees token counts, costs, model names, and project names.
|
||
|
||
**Q: How do I stop syncing?**
|
||
A: `codeburn sync logout` removes everything. Or just stop running `push`.
|