Configuration

try Everframe.shared.start(
    config: EverframeConfig(
        sdkKey: "evf_live_…",
        capture: CaptureConfig(network: true)
    )
)

EverframeConfig

CaptureConfig

networkBodies is a veto, not a switch: bodies are captured only when the server enables them and capture.network is true and networkBodies is not false. A client can turn body capture off and can never turn it on. See Server config.

Crash-only sessions

try Everframe.shared.start(
    config: EverframeConfig(sdkKey: "evf_live_…", reporterEnabled: false)
)

reporterEnabled: false turns the on-device reporter off for the whole session: report.open() throws. Crash and error capture, breadcrumbs, console and vitals keep working.

Use it in production builds that should report crashes without recording every session. Replay in a crash-only session follows the dashboard’s crash-only coverage, 0% by default, instead of the report coverage, and network bodies are not captured. See Session replay.

Runtime methods

Config is set once; these are called whenever.

Reading current state

Everframe.shared.captureGate            // Bool — is capture actually allowed?
Everframe.shared.currentConfig          // EverframeConfig?
Everframe.shared.currentUser            // EFUser?
Everframe.shared.captureUserSnapshot()  // EFCapturedUser
Everframe.shared.captureSessionSnapshot()
Everframe.SDK_VERSION                   // String

captureGate reports whether capture is armed — start() opens it and kill() closes it. It is not a summary of the server feature gates: replay and body capture have their own, so captureGate can be true while neither is running.

Quick capture

Quick capture files a draft report from a debug simulator with one gesture, with no form: a screenshot, the replay window, logs, breadcrumbs and network, as for a manual report. It is armed only on the iOS Simulator (tvOS is not yet verified); for real devices, see Quick capture on real devices. Every simulator build counts as a debug build, so set debugBuild: false in EverframeConfig to keep it off in a simulator Release build.

Real iPhones and iPads can quick capture too: link one to you or your team under Project settings → Devices, then shake it to capture. A real Apple TV works the same way: link it, then hold Play/Pause on the Siri Remote for about 1.5 s. In a debug build, the hold captures without linking. See Quick capture on real devices.

Press Shift+B in the simulator to capture. It is ignored while a text field has focus, so typing a capital B still types. A live capture card then appears in the dashboard, where you can title the capture and file it as a ticket.

Shift+B is the default because it is also what reaches an Android emulator, so one shortcut works on both. In the dashboard, under the app’s “Quick capture” card, you can pick another shortcut (double-tap Shift, or a chord such as ⌘⇧E), turn quick capture off, or turn off its replay. Saving a shortcut warns you about the ones the iOS Simulator reserves for itself.

You can also trigger a capture from your Mac, without focusing the simulator:

npx @everframe/cli capture

With more than one booted simulator or running emulator, pass --device <id>; the command lists them and exits when you do not.

To have captures private to you rather than in the shared inbox, log in once:

npx @everframe/cli login

It opens the dashboard, where you allow the login, then saves a personal capture token to ~/.everframe/credentials, which the SDK reads. Pass --no-browser to print the URL instead of opening it, or --url <api-url> for a self-hosted dashboard. The SDK sends the token only to the server it was issued by (the file’s url), so a debug build pointed at another server files its captures unattributed. npx @everframe/cli logout revokes the token and removes the file. You can also create a token yourself in the dashboard (Settings → Agents → Capture tokens) and save it in that file:

{ "token": "evf_cap_…" }

A missing or invalid token never blocks a capture; it just lands in the shared inbox. Drafts expire from the inbox after 7 days unless filed.

What iOS does not have

There is no debug, disabled or onError field, and no client-side sessionReplay block — replay is enabled entirely from the server.

Two-way replies are not implemented in the iOS SDK. There is no reply UI and no polling; the feature is web-only today.

To keep Everframe out of a build, do not call start.