DocsGetting started

Start here

Getting started

1. Start Akev

  • Desktop app: open Akev. The proxy starts automatically.
  • CLI: run akev. It prints the proxy address and opens the UI in your browser (akev start --no-open to skip opening). The browser opens a private redirect page from the data directory, so the access token never appears on a command line. If your browser can't open it (some snap or flatpak browsers), use the printed Web UI link. The browser then remembers the access for that Akev, so new tabs and bookmarks work until Akev restarts.

The first time, Traffic shows a three-step setup instead of an empty list:

  1. Trust the certificate on this computer: one click adds Akev's CA to your system's trust store (the system asks you to confirm; it says so when the CA is already trusted). See certificates.
  2. Pick what to capture: launch a browser or terminal that is set up already, or open Connect for phones, containers and everything else.
  3. Wait for the first request: the step shows it live as soon as it arrives, and offers to keep your traffic between restarts.

You can skip any step. To see it again, use Settings → General → Run the setup guide, or "Run the setup guide" in the command palette.

The status bar shows where the proxy listens (default 127.0.0.1:8000; if that port is busy Akev picks the next free one). Click the address to copy it. While the proxy runs on another port, Settings → Proxy offers Use port 8000: once the port is free again, it moves the proxy back without restarting (if the port is still busy, it says so and offers Retry).

2. Connect a client

Open Connect (Ctrl/⌘ 4) and pick a client. Connect clients covers each one in detail: what it changes, and how to undo it.

Client What happens
Chrome / Brave / Edge / Chromium / Opera / Vivaldi / Arc A separate browser profile launches, proxied through Akev and trusting its CA. Your normal browser is untouched.
Firefox A dedicated profile with proxy settings; the CA is installed automatically when NSS certutil is available, otherwise Firefox shows its one-click "Trust this CA" dialog.
Fresh Terminal A terminal window opens with HTTP(S)_PROXY and CA bundle variables set, so curl, git, Node, Python, Ruby, Go, Rust, Java and most CLIs are intercepted.
Existing terminal Paste a one-liner into a terminal you already have open. akev-off undoes it.
Android (ADB) With USB debugging enabled, Akev forwards the proxy over ADB, sets the device proxy and copies the CA certificate to the device for you to install.
iPhone and iPad Set the Wi-Fi proxy, scan the QR code and install the configuration profile.
Docker / Podman Run snippets/env files that route containers through Akev, or open an intercepted shell in a running container.
Electron apps Slack, VS Code, Postman or your own app launches with its traffic going through Akev.
System proxy Sets the OS-wide proxy (GNOME/KDE/macOS/Windows) and restores your previous settings on exit — even after a crash.
Any device Point the device's proxy at a LAN address shown in Connect, then open http://akev.cert (or scan the QR code) to install the certificate.

3. Inspect traffic

Requests stream into Traffic (Ctrl/⌘ 1). Select one to see request and response headers, bodies (pretty-printed, previewed or decoded), timings, TLS and connection details. Filter with the filter language, e.g. status:>=400 host:*.example.com.

4. Change traffic

Right-click a request → Create rule to mock its response, set a breakpoint, block the host or map it to a local file. Manage rules in Rules (Ctrl/⌘ 2); see rules.

5. Send requests

Compose (Ctrl/⌘ 3) sends requests directly or through your rules. Paste a cURL command into the URL bar to import it. Any captured request can be opened with Edit in Compose (Ctrl/⌘ E) or replayed (Ctrl/⌘ R).

6. Keep your traffic

Save what you captured as a named session, reopen it later, or turn on autosave so traffic survives restarts — and import Charles or mitmproxy captures. See sessions.

Trusting the certificate

Akev generates its own CA per installation (akev ca path prints where). Clients launched from Connect trust it automatically. For everything else (your OS, Firefox, Java, phones), see Certificates: the commands for each platform, how to remove the CA again, regenerating it and using your own.

Type to search guides, the CLI and the API.