Documentation

Quick Start

The fastest way to get Rift working is through the CLI. It walks you from account creation to branded domains, health checks, and your first real link.

What You End Up With

One branded link, routed everywhere

One public URL for people to click, with Rift routing each tap to the right destination.

click trackedattribution readyagent-readable

Recommended

Use the CLI

This is the best path if you want the smoothest setup. Rift guides you through signup, custom domains, diagnostics, and first success without making you remember the whole API.

curl -fsSL https://raw.githubusercontent.com/saltyskip/rift/main/client/cli/install.sh | sh

Or install from source: cargo install --git https://github.com/saltyskip/rift.git rift-cli

Advanced

Doing this manually?

If you prefer raw API calls and manual DNS setup, use the manual setup guide. That path is better for operators who want to script everything or understand every infrastructure step.

CLI flow

Create your account and local config

Start with rift init. It verifies your email, saves your secret key locally, and helps you create a first starter link.

rift init

Set up your branded domain

Rift guides you through your primary branded domain, verifies DNS, and can continue straight into your alternate domain for stronger Open in App behavior.

rift domains setup

If you want the DNS details behind this step, read Custom Domains.

Check what is ready

Once the domain flow is done, rift doctor tells you what you can already do and what is still worth finishing before production.

rift doctor

Create and inspect links

After onboarding, create a real link and test how it resolves across web, iOS, and Android.

rift links create
rift links test LINK_ID

Next steps

You now have a working setup on Rift's shared domain. Pick your next goal — most developers start with custom domains or an SDK integration.

Custom Domains

Set up branded links on your own domain.

→

Add iOS/Android for universal links and branded landing pages.

→

Publishable Keys

Create client-safe keys for the web and mobile SDKs.

→

Create Links

Create deep links with per-platform routing and metadata.

→

Web SDK

Add click tracking and attribution to your website.

→

iOS SDK

Integrate deep linking into your iOS app.

→

Android SDK

Integrate deep linking into your Android app.

→

Track Conversions

Measure signups, purchases, and deposits with backend webhooks.

→