Appearance
Install
Skyvern has three installation paths: the Python SDK (cloud API), the TypeScript SDK (cloud API), and self-hosted via pip or Docker Compose.
Option 1: Python SDK (Cloud)
Requires Python 3.11, 3.12, or 3.13.
bash
pip install skyvernGet an API key from app.skyvern.com and set it:
bash
export SKYVERN_API_KEY="your-api-key-here"Option 2: TypeScript SDK (Cloud)
bash
npm install @skyvern/clientSet the API key:
bash
export SKYVERN_API_KEY="your-api-key-here"Option 3: Self-Hosted via pip
Installs the full local server and UI. Requires Python 3.11+.
bash
pip install "skyvern[all]"
cp .env.example .env # edit as needed
skyvern quickstartThen open http://localhost:8080 in your browser.
Option 4: Self-Hosted via Docker Compose
No Python install required. Spins up Postgres, the API, and the UI together.
bash
git clone https://github.com/skyvern-ai/skyvern.git
cd skyvern
cp .env.example .env
docker compose up -dThen open http://localhost:8080.
Environment Variables
| Variable | Purpose |
|---|---|
SKYVERN_API_KEY | Cloud API key (cloud SDK path) |
SKYVERN_TELEMETRY | Set to false to disable telemetry (self-hosted) |
Template / Boilerplate
No dedicated starter repository is provided. The GitHub repo itself (github.com/Skyvern-AI/skyvern) contains example workflows in the examples/ directory.