Quickstart

This guide gets you from zero to a working Onklave session in about ten minutes. You’ll create an account, install the agent CLI, and run your first policy-controlled browser session.

Prerequisites

• A modern browser (Chrome, Firefox, Safari, Edge).
• A terminal (macOS, Linux, or Windows with WSL).
• A free Onklave account — sign up at portal.onklave.app.

1. Sign in to the portal

Open portal.onklave.app and sign in. The portal is where you manage organizations, policies, vault credentials, and audit logs.

If this is your first sign-in, a personal organization is created for you automatically. You can switch between organizations using the org switcher in the top-right corner.

2. Install the Agent CLI

The Agent CLI is the supported way to provision and operate Onklave agents on devices you own.

# macOS / Linux
curl -fsSL https://onklave.app/install/agent-cli | sh

# Verify
onklave-agent --version

For all install options, see the Agent CLI install guide.

3. Pair your device

From your terminal:

onklave-agent pair

This prints a short pairing code and a QR. Open the portal’s Devices tab and either enter the code or scan the QR with the Onklave mobile app. The device appears in the portal once pairing completes.

4. Start your first session

In the portal, click New Session, pick a target site from the catalog, and select your paired device. The remote browser streams to a new tab; every interaction is policy-checked and recorded.

When you close the tab, the session ends and is sealed in your audit log.

What’s next

• Learn the agent CLI inside-out — including daemon mode for unattended operation.
• Read the architecture overview to understand the streamed browser model.
• Integrate Onklave into your own application with the API quickstart.