Fast path

1. Pick the project you want to inspect.
2. Generate an account-owned API key from the app menu.
3. Send telemetry to https://diffed.ai/api.
4. Set commit_sha from CI or deploy metadata.

Python

import os
import diffed

diffed.init(
    api_key=os.environ["DIFFED_API_KEY"],
    endpoint="https://diffed.ai/api",
    commit_sha=os.environ.get("GITHUB_SHA") or os.environ.get("DIFFED_COMMIT_SHA"),
)
diffed.instrument_package("myapp")

How hosted lanes work

• Writes are scoped by the API key you generated for your account.
• The SDK does not need a separate hosted environment flag.
• Browser reads send project_id; the edge resolves that to the internal telemetry namespace for this hosted lane.
• dev.diffed.ai and diffed.ai are our hosted lanes, not the customer's deploy environments.

Keep repo and logs aligned

• Use one account-owned API key per installation unless you need to rotate or segment access.
• Emit the exact deployed commit SHA.
• Keep file paths stable relative to the repo root.
• Generate keys in the same project that owns the code.

Repo preview

Best path:

• Keep account identity separate from repo installs.
• Separate GitHub App for repo installs.
• Read-only permissions: repository metadata and contents.
• Optional later: pull request read access for PR compare context.

That keeps identity and code access separate, which is cleaner for org approval and safer in prod.

Later

• Repo install flow from the UI.
• Commit-to-GitHub blob links in the inspector.
• Private-file preview through a GitHub App token.