Installation

PHP 8.2+, Laravel 12 or 13, and Composer. For a single checklist with troubleshooting, use the Integration guide.

1. Install Sanvex

composer require sanvex/core sanvex/cli
php artisan migrate

php artisan migrate creates the sv_* tables (Sanvex migrations ship with sanvex/core and load automatically). You do not need a separate Sanvex migrate command. Confirm:

php artisan sanvex:list

2. Add drivers

composer require sanvex/gmail
# composer require sanvex/github
# composer require sanvex/linear
# composer require sanvex/notion
# composer require sanvex/slack

Run php artisan sanvex:list again — the new driver should appear.

3. Configuration

Environment variables

Set driver variables in .env (see each driver’s Configuration page). Example for Gmail OAuth:

GMAIL_CLIENT_ID=....apps.googleusercontent.com
GMAIL_CLIENT_SECRET=...
GMAIL_REDIRECT_URI="${APP_URL}/sanvex/gmail/callback"
GMAIL_SUCCESS_REDIRECT=/

APP_URL must match your running app and the provider’s redirect URI in their console.

Publish config (optional)

php artisan vendor:publish --tag=sanvex-config

Only needed if you want to edit config/sanvex.php in your app (custom drivers array, overrides). .env alone is enough for most installs.

Encryption key (optional)

php artisan sanvex:keygen

Copy the printed line into .env as SANVEX_KEK=.... If omitted, Sanvex uses APP_KEY. Per-driver details: Drivers. Core settings: Configuration.

4. Store credentials

API key drivers (GitHub, Notion internal, etc.):

php artisan sanvex:setup github --api-key="ghp_..."

OAuth drivers (Gmail, Notion public) — set client ID/secret in .env, then visit the built-in login URL (routes register when client ID is set):

Driver	Connect URL
Gmail	`GET /sanvex/gmail/login`
Notion	`GET /sanvex/notion/login`

See Gmail configuration and Notion configuration.

5. Verify

use Sanvex\Core\SanvexManager;

app(SanvexManager::class)->resolveDriver('gmail')->isConfigured();

php artisan tinker --execute="dump(app(\Sanvex\Core\SanvexManager::class)->resolveDriver('gmail')->isConfigured());"

Agent packages (optional)

composer require sanvex/laravel-ai
composer require sanvex/mcp

Laravel AI · MCP

Next step

Usage · Quickstart · Database

Getting Started

Concepts

Integrations

Installation

Installation

1. Install Sanvex

2. Add drivers

3. Configuration

Environment variables

Publish config (optional)

Encryption key (optional)

4. Store credentials

5. Verify

Agent packages (optional)

Next step

​Installation

​1. Install Sanvex

​2. Add drivers

​3. Configuration

​Environment variables

​Publish config (optional)

​Encryption key (optional)

​4. Store credentials

​5. Verify

​Agent packages (optional)

​Next step

Installation

1. Install Sanvex

2. Add drivers

3. Configuration

Environment variables

Publish config (optional)

Encryption key (optional)

4. Store credentials

5. Verify

Agent packages (optional)

Next step