Skip to content

Automate browser based workflows with AI

added py 3.13 and splited the cli and suport for windows and better port handling (#2404)

Prakash Maheshwaranad2ea8d069ec
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index ce7c748d8..4ef7a9be9 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -101,4 +101,4 @@ repos:
name: Alembic Check
entry: ./run_alembic_check.sh
language: script
- stages: [ commit ]
+ stages: [ pre-commit ]
diff --git a/README.md b/README.md
index 6773d1741..a4d419bea 100644
--- a/README.md
+++ b/README.md
@@ -313,6 +313,7 @@ Note: Our setup script does these two for you, but they are here for reference.
./run_ui.sh
```
1. Navigate to `http://localhost:8080` in your browser to start using the UI
+ *The Skyvern CLI supports Windows, WSL, macOS, and Linux environments.*
## Additional Setup for Contributors
If you're looking to contribute to Skyvern, you'll need to install the pre-commit hooks to ensure code quality and consistency. You can do this by running the following command:
diff --git a/docker-compose.yml b/docker-compose.yml
index d3ff4f2c2..1f0b82dd2 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -40,10 +40,8 @@ services:
- ENABLE_CODE_BLOCK=true
# - BROWSER_TYPE=cdp-connect
# Use this command to start Chrome with remote debugging:
- # To set up Chrome with remote debugging for CDP connection, use the Skyvern CLI:
- # skyvern init
- # and select option 3 (cdp-connect)
- # If you're using Docker, ensure Chrome is accessible from your container:
+ # "C:\Program Files\Google\Chrome\Application\chrome.exe" --remote-debugging-port=9222 --user-data-dir="C:\chrome-cdp-profile" --no-first-run --no-default-browser-check
+ # /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222 --user-data-dir="/Users/yourusername/chrome-cdp-profile" --no-first-run --no-default-browser-check
# - BROWSER_REMOTE_DEBUGGING_URL=http://host.docker.internal:9222/
# =========================
diff --git a/poetry.lock b/poetry.lock
index 5d2e18b48..f95dedc23 100644
--- a/poetry.lock
+++ b/poetry.lock
@@ -1,4 +1,16 @@
-# This file is automatically @generated by Poetry 2.1.1 and should not be changed by hand.
+# This file is automatically @generated by Poetry 2.1.3 and should not be changed by hand.
+
+[[package]]
+name = "about-time"
+version = "4.2.1"
+description = "Easily measure timing and throughput of code blocks, with beautiful human friendly representations."
+optional = false
+python-versions = ">=3.7, <4"
+groups = ["main"]
+files = [
+ {file = "about-time-4.2.1.tar.gz", hash = "sha256:6a538862d33ce67d997429d14998310e1dbfda6cb7d9bbfbf799c4709847fece"},
+ {file = "about_time-4.2.1-py3-none-any.whl", hash = "sha256:8bbf4c75fe13cbd3d72f49a03b02c5c7dca32169b6d49117c257e7eb3eaee341"},
+]
[[package]]
name = "aioboto3"
@@ -258,6 +270,22 @@ typing-extensions = ">=4.12"
[package.extras]
tz = ["tzdata"]
+[[package]]
+name = "alive-progress"
+version = "3.2.0"
+description = "A new kind of Progress Bar, with real-time throughput, ETA, and very cool animations!"
+optional = false
+python-versions = "<4,>=3.9"
+groups = ["main"]
+files = [
+ {file = "alive-progress-3.2.0.tar.gz", hash = "sha256:ede29d046ff454fe56b941f686f89dd9389430c4a5b7658e445cb0b80e0e4deb"},
+ {file = "alive_progress-3.2.0-py3-none-any.whl", hash = "sha256:0677929f8d3202572e9d142f08170b34dbbe256cc6d2afbf75ef187c7da964a8"},
+]
+
+[package.dependencies]
+about-time = "4.2.1"
+grapheme = "0.6.0"
+
[[package]]
name = "annotated-types"
version = "0.7.0"
@@ -597,7 +625,7 @@ description = "Backport of CPython tarfile module"
optional = false
python-versions = ">=3.8"
groups = ["dev"]
-markers = "python_version == \"3.11\" and platform_machine != \"ppc64le\" and platform_machine != \"s390x\""
+markers = "platform_machine != \"ppc64le\" and platform_machine != \"s390x\" and python_version == \"3.11\""
files = [
{file = "backports.tarfile-1.2.0-py3-none-any.whl", hash = "sha256:77e284d754527b01fb1e6fa8a1afe577858ebe4e9dad8919e34c862cb399bc34"},
{file = "backports_tarfile-1.2.0.tar.gz", hash = "sha256:d75e02c268746e1b8144c278978b6e98e85de6ad16f8e4b0844a154557eca991"},
@@ -985,7 +1013,6 @@ files = [
{file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"},
{file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"},
]
-markers = {main = "platform_system == \"Windows\" or sys_platform == \"win32\"", dev = "platform_system == \"Windows\" or sys_platform == \"win32\" or os_name == \"nt\""}
[[package]]
name = "coloredlogs"
@@ -2008,6 +2035,20 @@ protobuf = ">=3.20.2,<4.21.1 || >4.21.1,<4.21.2 || >4.21.2,<4.21.3 || >4.21.3,<4
[package.extras]
grpc = ["grpcio (>=1.44.0,<2.0.0)"]
+[[package]]
+name = "grapheme"
+version = "0.6.0"
+description = "Unicode grapheme helpers"
+optional = false
+python-versions = "*"
+groups = ["main"]
+files = [
+ {file = "grapheme-0.6.0.tar.gz", hash = "sha256:44c2b9f21bbe77cfb05835fec230bd435954275267fea1858013b102f8603cca"},
+]
+
+[package.extras]
+test = ["pytest", "sphinx", "sphinx-autobuild", "twine", "wheel"]
+
[[package]]
name = "greenlet"
version = "3.2.2"
@@ -2535,7 +2576,7 @@ files = [
{file = "importlib_metadata-8.6.1-py3-none-any.whl", hash = "sha256:02a89390c1e15fdfdc0d7c6b25cb3e62650d0494005c97d6f148bf5b9787525e"},
{file = "importlib_metadata-8.6.1.tar.gz", hash = "sha256:310b41d755445d74569f993ccfc22838295d9fe005425094fad953d7f15c8580"},
]
-markers = {dev = "python_version == \"3.11\" and platform_machine != \"ppc64le\" and platform_machine != \"s390x\""}
+markers = {dev = "platform_machine != \"ppc64le\" and platform_machine != \"s390x\" and python_version == \"3.11\""}
[package.dependencies]
zipp = ">=3.20"
@@ -4027,7 +4068,7 @@ description = "ONNX Runtime is a runtime accelerator for Machine Learning models
optional = false
python-versions = ">=3.10"
groups = ["main"]
-markers = "python_version == \"3.13\" or python_version == \"3.12\""
+markers = "python_version >= \"3.12\""
files = [
{file = "onnxruntime-1.22.0-cp310-cp310-macosx_13_0_universal2.whl", hash = "sha256:85d8826cc8054e4d6bf07f779dc742a363c39094015bdad6a08b3c18cfe0ba8c"},
{file = "onnxruntime-1.22.0-cp310-cp310-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:468c9502a12f6f49ec335c2febd22fdceecc1e4cc96dfc27e419ba237dff5aff"},
@@ -7420,7 +7461,7 @@ files = [
{file = "zipp-3.21.0-py3-none-any.whl", hash = "sha256:ac1bbe05fd2991f160ebce24ffbac5f6d11d83dc90891255885223d42b3cd931"},
{file = "zipp-3.21.0.tar.gz", hash = "sha256:2c9958f6430a2040341a52eb608ed6dd93ef4392e02ffe219417c1b28b5dd1f4"},
]
-markers = {dev = "python_version == \"3.11\" and platform_machine != \"ppc64le\" and platform_machine != \"s390x\""}
+markers = {dev = "platform_machine != \"ppc64le\" and platform_machine != \"s390x\" and python_version == \"3.11\""}
[package.extras]
check = ["pytest-checkdocs (>=2.4)", "pytest-ruff (>=0.2.1) ; sys_platform != \"cygwin\""]
@@ -7433,4 +7474,4 @@ type = ["pytest-mypy"]
[metadata]
lock-version = "2.1"
python-versions = ">=3.11,<3.14"
-content-hash = "b9c4466c480ee963b83932fdf4a4733756d45401375c5159e7b592eff5aa22f2"
+content-hash = "50a88fc2c1fe1c8fc6e3a2b1602dd5fab675b5cb3dcc995e43bc07d97273d8d0"
diff --git a/pyproject.toml b/pyproject.toml
index e0b87ab38..f04528888 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -68,6 +68,8 @@ psutil = ">=7.0.0"
tiktoken = ">=0.9.0"
anthropic = "^0.50.0"
google-cloud-aiplatform = "^1.90.0"
+alive-progress = "^3.2.0"
+colorama = "^0.4.6"
[tool.poetry.group.dev.dependencies]
isort = "^5.13.2"
diff --git a/skyvern/cli/browser.py b/skyvern/cli/browser.py
new file mode 100644
index 000000000..b795bc3e7
--- /dev/null
+++ b/skyvern/cli/browser.py
@@ -0,0 +1,139 @@
+import os
+import subprocess
+from urllib.parse import urlparse
+
+import requests # type: ignore
+from rich.panel import Panel
+from rich.prompt import Confirm, Prompt
+
+from skyvern.utils import detect_os
+
+from .console import console
+
+
+def get_default_chrome_location(host_system: str) -> str:
+ """Get the default Chrome/Chromium location based on OS."""
+ if host_system == "darwin":
+ return "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
+ if host_system == "linux":
+ chrome_paths = ["/usr/bin/google-chrome", "/usr/bin/chromium", "/usr/bin/chromium-browser"]
+ for path in chrome_paths:
+ if os.path.exists(path):
+ return path
+ return "/usr/bin/google-chrome"
+ if host_system == "wsl":
+ return "/mnt/c/Program Files/Google/Chrome/Application/chrome.exe"
+ return "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe"
+
+
+def setup_browser_config() -> tuple[str, str | None, str | None]:
+ """Configure browser settings for Skyvern."""
+ console.print(Panel("\n[bold blue]Configuring web browser for scraping...[/bold blue]", border_style="cyan"))
+ browser_types = ["chromium-headless", "chromium-headful", "cdp-connect"]
+
+ for i, browser_type in enumerate(browser_types, 1):
+ console.print(f"[cyan]{i}.[/cyan] [bold]{browser_type}[/bold]")
+ if browser_type == "chromium-headless":
+ console.print(" - Runs Chrome in [italic]headless[/italic] mode (no visible window)")
+ elif browser_type == "chromium-headful":
+ console.print(" - Runs Chrome with [italic]visible window[/italic]")
+ elif browser_type == "cdp-connect":
+ console.print(" - Connects to an [italic]existing Chrome instance[/italic]")
+ console.print(" - [yellow]Requires Chrome to be running with remote debugging enabled[/yellow]")
+
+ selected_browser_idx = Prompt.ask(
+ "\nChoose browser type", choices=[str(i) for i in range(1, len(browser_types) + 1)]
+ )
+ selected_browser = browser_types[int(selected_browser_idx) - 1]
+ console.print(f"Selected browser: [bold green]{selected_browser}[/bold green]")
+
+ browser_location = None
+ remote_debugging_url = None
+
+ if selected_browser == "cdp-connect":
+ host_system = detect_os()
+ default_location = get_default_chrome_location(host_system)
+ console.print(f"\n[italic]Default Chrome location for your system:[/italic] [cyan]{default_location}[/cyan]")
+ browser_location = Prompt.ask(
+ "Enter Chrome executable location (press Enter to use default)", default=default_location
+ )
+ if not browser_location:
+ browser_location = default_location
+
+ if not os.path.exists(browser_location):
+ console.print(
+ f"[yellow]Warning: Chrome not found at {browser_location}. Please verify the location is correct.[/yellow]"
+ )
+
+ console.print("\n[bold]To use CDP connection, Chrome must be running with remote debugging enabled.[/bold]")
+ console.print("Example: [code]chrome --remote-debugging-port=9222[/code]")
+ console.print("[italic]Default debugging URL: [cyan]http://localhost:9222[/cyan][/italic]")
+
+ default_port = "9222"
+ if remote_debugging_url is None:
+ remote_debugging_url = "http://localhost:9222"
+ elif urlparse(remote_debugging_url).port is not None:
+ default_port = remote_debugging_url.split(":")[-1].split("/")[0]
+
+ parsed_url = urlparse(remote_debugging_url)
+ version_url = f"{parsed_url.scheme}://{parsed_url.netloc}/json/version"
+
+ with console.status(
+ f"[bold green]Checking if Chrome is already running with remote debugging on port {default_port}..."
+ ) as status:
+ try:
+ response = requests.get(version_url, timeout=2)
+ if response.status_code == 200:
+ try:
+ browser_info = response.json()
+ console.print("βœ… [green]Chrome is already running with remote debugging![/green]")
+ if "Browser" in browser_info:
+ console.print(f" Browser: [bold]{browser_info['Browser']}[/bold]")
+ if "webSocketDebuggerUrl" in browser_info:
+ console.print(f" WebSocket URL: [link]{browser_info['webSocketDebuggerUrl']}[/link]")
+ console.print(f" Connected to [link]{remote_debugging_url}[/link]")
+ return selected_browser, browser_location, remote_debugging_url
+ except ValueError:
+ console.print(
+ "[yellow]Port is in use, but doesn't appear to be Chrome with remote debugging.[/yellow]"
+ )
+ else:
+ console.print(f"[yellow]Chrome responded with status code {response.status_code}.[/yellow]")
+ except requests.RequestException:
+ console.print(f"[red]No Chrome instance detected on {remote_debugging_url}[/red]")
+ status.stop()
+
+ console.print("\n[bold]Executing Chrome with remote debugging enabled:[/bold]")
+
+ if host_system == "darwin" or host_system == "linux":
+ chrome_cmd = f'{browser_location} --remote-debugging-port={default_port} --user-data-dir="$HOME/chrome-cdp-profile" --no-first-run --no-default-browser-check'
+ console.print(f" [code]{chrome_cmd}[/code]")
+ elif host_system == "windows" or host_system == "wsl":
+ chrome_cmd = f'"{browser_location}" --remote-debugging-port={default_port} --user-data-dir="C:\\chrome-cdp-profile" --no-first-run --no-default-browser-check'
+ console.print(f" [code]{chrome_cmd}[/code]")
+ else:
+ console.print("[red]Unsupported OS for Chrome configuration. Please set it up manually.[/red]")
+
+ execute_browser = Confirm.ask("\nWould you like to start Chrome with remote debugging now?")
+ if execute_browser:
+ console.print(
+ f"πŸš€ [bold green]Starting Chrome with remote debugging on port {default_port}...\n[/bold green]"
+ )
+ try:
+ if host_system in ["darwin", "linux"]:
+ subprocess.Popen(f"nohup {chrome_cmd} > /dev/null 2>&1 &", shell=True)
+ elif host_system == "windows":
+ subprocess.Popen(f"start {chrome_cmd}", shell=True)
+ elif host_system == "wsl":
+ subprocess.Popen(f"cmd.exe /c start {chrome_cmd}", shell=True)
+ except Exception as e: # pragma: no cover - CLI safeguards
+ console.print(f"[red]Error starting Chrome: {e}[/red]")
+ console.print("[italic]Please start Chrome manually using the command above.[/italic]")
+
+ remote_debugging_url = Prompt.ask(
+ "Enter remote debugging URL (press Enter for default)", default="http://localhost:9222"
+ )
+ if not remote_debugging_url:
+ remote_debugging_url = "http://localhost:9222"
+
+ return selected_browser, browser_location, remote_debugging_url
diff --git a/skyvern/cli/commands.py b/skyvern/cli/commands.py
index fa9e2ab90..5de96d130 100644
--- a/skyvern/cli/commands.py
+++ b/skyvern/cli/commands.py
@@ -1,1260 +1,24 @@
-import asyncio
-import json
-import os
-import shutil
-import subprocess
-import time
-import uuid
-import webbrowser
-from enum import Enum
-from pathlib import Path
-from typing import Any, Callable, Optional, cast
-from urllib.parse import urlparse
-
-import requests # type: ignore
import typer
-from dotenv import load_dotenv, set_key
-from rich.console import Console
-from rich.markdown import Markdown
-from rich.panel import Panel
-from rich.progress import Progress, SpinnerColumn, TextColumn
-from rich.table import Table
-
-from skyvern.config import settings
-from skyvern.forge import app
-from skyvern.forge.sdk.db.enums import OrganizationAuthTokenType
-from skyvern.library import Skyvern
-from skyvern.utils import detect_os, get_windows_appdata_roaming, migrate_db
-
-# Initialize Rich console for better formatting
-console = Console()
-
-# Main application
-cli_app = typer.Typer(
- help="Skyvern - Browser automation powered by LLMs and Computer Vision",
- add_completion=False,
-)
+from dotenv import load_dotenv
-# Subcommands
-run_app = typer.Typer(help="Run Skyvern components")
-setup_app = typer.Typer(help="Set up Skyvern configurations")
-tasks_app = typer.Typer(help="Manage Skyvern tasks")
-workflows_app = typer.Typer(help="Manage Skyvern workflows")
-docs_app = typer.Typer(help="Access Skyvern documentation")
+from .docs import docs_app
+from .init_command import init
+from .run_commands import run_app
+from .setup_commands import setup_mcp_command
+from .tasks import tasks_app
+from .workflow import workflow_app
-# Add subcommands to main app
+cli_app = typer.Typer()
cli_app.add_typer(run_app, name="run")
-cli_app.add_typer(setup_app, name="setup")
+cli_app.add_typer(workflow_app, name="workflow")
cli_app.add_typer(tasks_app, name="tasks")
-cli_app.add_typer(workflows_app, name="workflows")
cli_app.add_typer(docs_app, name="docs")
+setup_app = typer.Typer()
+cli_app.add_typer(setup_app, name="setup")
-# Documentation sections and their URLs
-
-# Documentation sections and their URLs
-DOCUMENTATION = {
- "quickstart": "https://docs.skyvern.com/introduction",
- "tasks": "https://docs.skyvern.com/running-tasks/introduction",
- "workflows": "https://docs.skyvern.com/workflows/introduction",
- "prompting": "https://docs.skyvern.com/getting-started/prompting-guide",
- "api": "https://docs.skyvern.com/integrations/api",
-}
-
-
-class DeploymentType(str, Enum):
- LOCAL = "local"
- CLOUD = "cloud"
-
-
-class BrowserType(str, Enum):
- HEADLESS = "chromium-headless"
- HEADFUL = "chromium-headful"
- CDP = "cdp-connect"
-
-
-# ----------------------------------------------------
-# 1. Guided Onboarding Flow
-# ----------------------------------------------------
-
-
-@cli_app.command(name="init")
-def init(
- deployment: Optional[DeploymentType] = typer.Option(None, help="Deployment type: local or cloud"),
- no_postgres: bool = typer.Option(False, "--no-postgres", help="Skip starting PostgreSQL container"),
-) -> None:
- """
- Initialize Skyvern with a guided setup process.
-
- This wizard will help you configure Skyvern for either local development
- or connection to Skyvern Cloud. It will guide you through:
-
- - Choosing deployment type (local or cloud)
- - Setting up database (for local deployment)
- - Configuring LLM providers
- - Setting up browser automation
- - Configuring integrations
- """
- console.print(
- Panel.fit(
- "[bold blue]Welcome to Skyvern Setup Wizard[/]", subtitle="Let's get you started with browser automation"
- )
- )
-
- # Step 1: Choose deployment type
- if deployment is None:
- console.print(Markdown("## Step 1: Choose Deployment Type"))
- console.print("\n[yellow]Local deployment[/] - Run Skyvern on your machine")
- console.print(" β€’ Requires local database and LLM API keys")
- console.print(" β€’ Good for development and testing")
- console.print("\n[yellow]Cloud deployment[/] - Connect to Skyvern Cloud")
- console.print(" β€’ Managed service with no local infrastructure")
- console.print(" β€’ Production-ready with built-in scaling")
-
- deployment_choice = (
- console.input("\n[bold]Deploy locally or connect to cloud? [cloud/local] [/]").strip().lower()
- )
- run_local = deployment_choice == "local"
- else:
- run_local = deployment == DeploymentType.LOCAL
-
- with Progress(SpinnerColumn(), TextColumn("[progress.description]{task.description}"), console=console) as progress:
- if run_local:
- # Step 2: Set up local infrastructure (for local deployment)
- setup_task = progress.add_task("[green]Setting up local infrastructure...", total=1)
-
- if not no_postgres:
- setup_postgresql(no_postgres)
-
- migrate_db()
-
- api_key_task = progress.add_task("[green]Generating API key...", total=1)
- api_key = asyncio.run(_setup_local_organization())
- progress.update(api_key_task, completed=1)
-
- # Step 3: Configure LLM providers
- progress.update(setup_task, completed=1)
- llm_task = progress.add_task("[green]Setting up LLM providers...", total=1)
- setup_llm_providers()
- progress.update(llm_task, completed=1)
-
- # Step 4: Configure browser settings
- browser_task = progress.add_task("[green]Setting up browser automation...", total=1)
- browser_type, browser_location, remote_debugging_url = setup_browser_config()
- update_or_add_env_var("BROWSER_TYPE", browser_type)
- if browser_location:
- update_or_add_env_var("CHROME_EXECUTABLE_PATH", browser_location)
- if remote_debugging_url:
- update_or_add_env_var("BROWSER_REMOTE_DEBUGGING_URL", remote_debugging_url)
- progress.update(browser_task, completed=1)
-
- # Set defaults for local development
- update_or_add_env_var("SKYVERN_BASE_URL", "http://localhost:8000")
- else:
- # Configure for cloud deployment
- cloud_task = progress.add_task("[green]Setting up Skyvern Cloud connection...", total=1)
-
- base_url = console.input("\nEnter Skyvern base URL [https://api.skyvern.com]: ").strip()
- if not base_url:
- base_url = "https://api.skyvern.com"
-
- console.print("\nTo get your API key:")
- console.print("1. Create an account at [link=https://app.skyvern.com]https://app.skyvern.com[/link]")
- console.print("2. Go to Settings")
- console.print("3. Copy your API key")
-
- api_key = console.input("\nEnter your Skyvern API key: ").strip()
- while not api_key:
- console.print("[bold red]API key is required[/]")
- api_key = console.input("Enter your Skyvern API key: ").strip()
-
- update_or_add_env_var("SKYVERN_BASE_URL", base_url)
- progress.update(cloud_task, completed=1)
-
- # Common configuration
- analytics_task = progress.add_task("[green]Finalizing configuration...", total=1)
-
- # Ask for email or generate UUID for analytics
- analytics_id = console.input("\nPlease enter your email for analytics (press enter to skip): ")
- if not analytics_id:
- analytics_id = str(uuid.uuid4())
-
- update_or_add_env_var("ANALYTICS_ID", analytics_id)
- update_or_add_env_var("SKYVERN_API_KEY", api_key)
- progress.update(analytics_task, completed=1)
-
- # Step 5: Configure integrations
- console.print(Markdown("\n## Step 5: Configure Integrations"))
- configure_mcp = typer.confirm(
- "Would you like to configure AI integrations (Claude, Cursor, Windsurf)?", default=True
- )
- if configure_mcp:
- setup_mcp()
- console.print("\n[green]AI integrations configured successfully![/]")
-
- if run_local:
- # Install required components for local deployment
- console.print(Markdown("\n## Step 6: Installing Components"))
- with Progress(
- SpinnerColumn(), TextColumn("[progress.description]{task.description}"), console=console
- ) as progress:
- browser_install_task = progress.add_task("[green]Installing Chromium browser...", total=1)
- subprocess.run(["playwright", "install", "chromium"], check=True)
- progress.update(browser_install_task, completed=1)
-
- # Success message and next steps
- console.print(
- Panel.fit("[bold green]Skyvern setup complete![/]", subtitle="You're ready to start automating browsers")
- )
-
- if run_local:
- console.print("\n[bold]Next steps:[/]")
- console.print("1. Start the Skyvern server: [yellow]skyvern run server[/]")
- console.print("2. Start the Skyvern UI: [yellow]skyvern run ui[/]")
- else:
- console.print("\n[bold]Next steps:[/]")
- console.print(
- "1. Visit the Skyvern Cloud dashboard: [link=https://app.skyvern.com]https://app.skyvern.com[/link]"
- )
- console.print("2. Try using an AI integration: [yellow]skyvern docs integrations[/]")
-
-
-# ----------------------------------------------------
-# 3. Improved Documentation Integration
-# ----------------------------------------------------
-
-
-@docs_app.command(name="open")
-def open_docs(section: str = typer.Argument("quickstart", help="Documentation section to open")) -> None:
- """
- Open Skyvern documentation in your web browser.
-
- Available sections:
- - quickstart: Getting started guide
- - tasks: Task creation and running
- - workflows: Workflow creation and running
- - prompting: Best practices for writing prompts
- - api: API reference
- """
- if section not in DOCUMENTATION:
- console.print(f"[bold red]Error:[/] Documentation section '{section}' not found")
- console.print("\nAvailable sections:")
- for name, url in DOCUMENTATION.items():
- console.print(f" β€’ [bold]{name}[/] - {url}")
- return
-
- url = DOCUMENTATION[section]
- console.print(f"Opening documentation section: [bold]{section}[/]")
- console.print(f"URL: [link={url}]{url}[/link]")
- webbrowser.open(url)
-
-
-@docs_app.command(name="prompting")
-def prompting_guide() -> None:
- """
- Show prompting best practices for Skyvern.
- """
- console.print(
- Panel.fit("[bold blue]Skyvern Prompting Best Practices[/]", subtitle="Tips for writing effective prompts")
- )
-
- console.print(
- Markdown("""
-## General Guidelines
-
-1. **Be specific and detailed**
- - Specify exactly what actions should be taken
- - Include any data or criteria needed for decisions
-
-2. **Define completion criteria**
- - Use COMPLETE/TERMINATE markers to indicate success/failure conditions
- - Specify what data to extract (if any)
-
-3. **Break complex tasks into steps**
- - For multi-page flows, describe each step clearly
- - Use sequencing terms (first, then, after)
-
-## Examples
-
-βœ… **Good prompt:**
-```
-Navigate to the products page. Find the product named "Wireless Headphones"
-and add it to the cart. Proceed to checkout and fill the form with:
-Name: John Doe
-When complete, extract the order confirmation number.
-COMPLETE when you see a "Thank you for your order" message.
-```
-
-❌ **Less effective prompt:**
-```
-Buy wireless headphones and check out.
-```
-
-## For More Information
-
-Run `skyvern docs open prompting` to see the complete prompting guide online.
- """)
- )
-
-
-# ----------------------------------------------------
-# 4. User-Friendly Management Commands
-# ----------------------------------------------------
-
-
-@cli_app.command(name="status")
-def status() -> None:
- """
- Check the status of Skyvern services.
- """
- console.print(Panel.fit("[bold blue]Skyvern Services Status[/]", subtitle="Checking all system components"))
-
- # Check for .env file
- env_path = Path(".env")
- env_status = "βœ… Found" if env_path.exists() else "❌ Not found"
-
- # Check database connection
- db_status = "⏳ Checking..."
- try:
- load_dotenv()
- # Simple check - just see if we can run a migrate command without error
- migrate_db()
- db_status = "βœ… Connected"
- except Exception:
- db_status = "❌ Not connected"
-
- # Check if server is running (port 8000)
- server_status = "⏳ Checking..."
- try:
- import socket
-
- s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
- s.settimeout(0.5)
- s.connect(("localhost", 8000))
- s.close()
- server_status = "βœ… Running"
- except Exception:
- server_status = "❌ Not running"
-
- # Check if UI is running (port 8080)
- ui_status = "⏳ Checking..."
- try:
- import socket
-
- s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
- s.settimeout(0.5)
- s.connect(("localhost", 8080))
- s.close()
- ui_status = "βœ… Running"
- except Exception:
- ui_status = "❌ Not running"
-
- # Check API key
- api_key = os.getenv("SKYVERN_API_KEY", "")
- api_key_status = "βœ… Configured" if api_key else "❌ Not configured"
-
- # Display status table
- table = Table(title="Skyvern Services")
- table.add_column("Component", style="cyan")
- table.add_column("Status", style="green")
- table.add_column("Action to Fix", style="yellow")
-
- table.add_row("Configuration (.env)", env_status, "Run: skyvern init" if env_status.startswith("❌") else "")
- table.add_row("Database", db_status, "Check DATABASE_STRING in .env" if db_status.startswith("❌") else "")
- table.add_row("Server", server_status, "Run: skyvern run server" if server_status.startswith("❌") else "")
- table.add_row("UI", ui_status, "Run: skyvern run ui" if ui_status.startswith("❌") else "")
- table.add_row("API Key", api_key_status, "Run: skyvern init" if api_key_status.startswith("❌") else "")
-
- console.print(table)
-
- if "❌" in f"{env_status}{db_status}{server_status}{ui_status}{api_key_status}":
- console.print("\n[bold yellow]Some components need attention.[/] Fix the issues above to get started.")
- else:
- console.print("\n[bold green]All systems operational![/] Skyvern is ready to use.")
-
-
-@tasks_app.command(name="list")
-def list_tasks() -> None:
- """
- List recent Skyvern tasks.
- """
- console.print(Panel.fit("[bold blue]Recent Skyvern Tasks[/]", subtitle="Retrieving task history"))
-
- try:
- # Initialize Skyvern client
- load_dotenv()
- skyvern_agent = Skyvern(
- base_url=settings.SKYVERN_BASE_URL,
- api_key=settings.SKYVERN_API_KEY,
- )
-
- # Get tasks
- with Progress(
- SpinnerColumn(), TextColumn("[progress.description]{task.description}"), console=console
- ) as progress:
- task = progress.add_task("[green]Fetching recent tasks...", total=1)
- tasks = asyncio.run(skyvern_agent.get_tasks())
- progress.update(task, completed=1)
-
- if not tasks:
- console.print("[yellow]No tasks found[/]")
- return
-
- # Display tasks
- table = Table(title=f"Tasks ({len(tasks)} found)")
- table.add_column("ID", style="cyan", no_wrap=True)
- table.add_column("Title", style="green")
- table.add_column("Status", style="yellow")
- table.add_column("Created", style="blue")
-
- for task in tasks:
- table.add_row(
- str(task.id),
- task.title or "Untitled",
- task.status or "Unknown",
- task.created_at.strftime("%Y-%m-%d %H:%M:%S") if task.created_at else "Unknown",
- )
-
- console.print(table)
-
- # Show help for next steps
- console.print("\n[bold]Next steps:[/]")
- console.print("β€’ View task details: [yellow]skyvern tasks show <task_id>[/]")
- console.print("β€’ Retry a task: [yellow]skyvern tasks retry <task_id>[/]")
-
- except Exception as e:
- console.print(f"[bold red]Error listing tasks:[/] {str(e)}")
- console.print("[yellow]Make sure your API key is set correctly in .env[/]")
-
-
-@tasks_app.command(name="create")
-def create_task(
- prompt: str = typer.Option(..., "--prompt", "-p", help="Task prompt"),
- url: str = typer.Option(..., "--url", "-u", help="Starting URL"),
- schema: Optional[str] = typer.Option(None, "--schema", "-s", help="Data extraction schema (JSON)"),
- output_json: bool = typer.Option(False, "--json", help="Output results as JSON"),
-) -> None:
- """
- Create and run a new Skyvern task.
- """
- console.print(Panel.fit("[bold blue]Creating New Skyvern Task[/]", subtitle="Running browser automation"))
-
- console.print(f"[bold]Prompt:[/] {prompt}")
- console.print(f"[bold]URL:[/] {url}")
- if schema:
- console.print(f"[bold]Schema:[/] {schema}")
-
- try:
- # Initialize Skyvern client
- load_dotenv()
- skyvern_agent = Skyvern(
- base_url=settings.SKYVERN_BASE_URL,
- api_key=settings.SKYVERN_API_KEY,
- )
-
- # Create and run task
- with Progress(
- SpinnerColumn(), TextColumn("[progress.description]{task.description}"), console=console
- ) as progress:
- task = progress.add_task("[green]Running task...", total=1)
-
- result = asyncio.run(
- skyvern_agent.run_task(prompt=prompt, url=url, data_extraction_schema=schema, user_agent="skyvern-cli")
- )
-
- progress.update(task, completed=1)
-
- # Display result
- if output_json:
- console.print_json(json.dumps(result.model_dump()))
- else:
- console.print("\n[bold green]Task completed successfully![/]")
- console.print(f"\n[bold]Output:[/] {result.model_dump()['output']}")
-
- # Display path to view results
- base_url = settings.SKYVERN_BASE_URL
- run_history_url = (
- "https://app.skyvern.com/history" if "skyvern.com" in base_url else "http://localhost:8080/history"
- )
- console.print(f"\nView details at: [link={run_history_url}]{run_history_url}[/link]")
-
- except Exception as e:
- console.print(f"[bold red]Error creating task:[/] {str(e)}")
- console.print("[yellow]Make sure your API key is set correctly in .env[/]")
-
-
-@workflows_app.command(name="list")
-def list_workflows() -> None:
- """
- List Skyvern workflows.
- """
- console.print(Panel.fit("[bold blue]Skyvern Workflows[/]", subtitle="Retrieving available workflows"))
-
- try:
- # Initialize Skyvern client
- load_dotenv()
- skyvern_agent = Skyvern(
- base_url=settings.SKYVERN_BASE_URL,
- api_key=settings.SKYVERN_API_KEY,
- )
-
- # Get workflows
- with Progress(
- SpinnerColumn(), TextColumn("[progress.description]{task.description}"), console=console
- ) as progress:
- task = progress.add_task("[green]Fetching workflows...", total=1)
- workflows = asyncio.run(skyvern_agent.get_workflows())
- progress.update(task, completed=1)
-
- if not workflows:
- console.print("[yellow]No workflows found[/]")
- return
-
- # Display workflows
- table = Table(title=f"Workflows ({len(workflows)} found)")
- table.add_column("ID", style="cyan", no_wrap=True)
- table.add_column("Title", style="green")
- table.add_column("Status", style="yellow")
- table.add_column("Created", style="blue")
-
- for workflow in workflows:
- table.add_row(
- str(workflow.id),
- workflow.title or "Untitled",
- workflow.status or "Unknown",
- workflow.created_at.strftime("%Y-%m-%d %H:%M:%S")
- if hasattr(workflow, "created_at") and workflow.created_at
- else "Unknown",
- )
-
- console.print(table)
-
- # Show help for next steps
- console.print("\n[bold]Next steps:[/]")
- console.print("β€’ View workflow details: [yellow]skyvern workflows show <workflow_id>[/]")
- console.print("β€’ Run a workflow: [yellow]skyvern workflows run <workflow_id>[/]")
-
- except Exception as e:
- console.print(f"[bold red]Error listing workflows:[/] {str(e)}")
- console.print("[yellow]Make sure your API key is set correctly in .env[/]")
-
-
-# ----------------------------------------------------
-# 5. Streamlined Configuration (Original functions enhanced)
-# ----------------------------------------------------
-
-
-def setup_postgresql(no_postgres: bool = False) -> None:
- """Set up PostgreSQL database for Skyvern with improved feedback."""
- console.print(Markdown("## Database Setup"))
-
- if command_exists("psql") and is_postgres_running():
- console.print("[green]βœ“[/] PostgreSQL is already running locally")
- if database_exists("skyvern", "skyvern"):
- console.print("[green]βœ“[/] Database and user exist")
- else:
- console.print("[yellow]![/] Creating database and user...")
- create_database_and_user()
- console.print("[green]βœ“[/] Database created successfully")
- return
-
- if no_postgres:
- console.print("[yellow]![/] Skipping PostgreSQL setup as requested")
- console.print(" If using Docker Compose, its Postgres service will start automatically")
- return
-
- if not is_docker_running():
- console.print("[bold red]Γ—[/] Docker is not running or not installed")
- console.print(" Please install or start Docker and try again")
- exit(1)
-
- if is_postgres_running_in_docker():
- console.print("[green]βœ“[/] PostgreSQL is already running in Docker")
- else:
- if not no_postgres:
- console.print("[yellow]![/] No local Postgres detected")
- start_postgres = typer.confirm(
- "Start a disposable container now? (Choose 'n' if using Docker Compose)", default=True
- )
-
- if not start_postgres:
- console.print("[yellow]![/] Skipping PostgreSQL container setup")
- console.print(" If using Docker Compose, its Postgres service will start automatically")
- return
-
- console.print("[yellow]![/] Attempting to install PostgreSQL via Docker...")
- if not is_postgres_container_exists():
- run_command(
- "docker run --name postgresql-container -e POSTGRES_HOST_AUTH_METHOD=trust -d -p 5432:5432 postgres:14"
- )
- else:
- run_command("docker start postgresql-container")
- console.print("[green]βœ“[/] PostgreSQL has been installed and started using Docker")
-
- console.print("[yellow]![/] Waiting for PostgreSQL to start...")
- time.sleep(20)
-
- # Set up user and database in Docker postgres if needed
- _, code = run_command('docker exec postgresql-container psql -U postgres -c "\\du" | grep -q skyvern', check=False)
- if code == 0:
- console.print("[green]βœ“[/] Database user exists")
- else:
- console.print("[yellow]![/] Creating database user...")
- run_command("docker exec postgresql-container createuser -U postgres skyvern")
-
- _, code = run_command(
- "docker exec postgresql-container psql -U postgres -lqt | cut -d \\| -f 1 | grep -qw skyvern", check=False
- )
- if code == 0:
- console.print("[green]βœ“[/] Database exists")
- else:
- console.print("[yellow]![/] Creating database...")
- run_command("docker exec postgresql-container createdb -U postgres skyvern -O skyvern")
- console.print("[green]βœ“[/] Database and user created successfully")
-
-
-def setup_llm_providers() -> None:
- """Configure Large Language Model (LLM) Providers with improved UI."""
- console.print(Markdown("## LLM Provider Configuration"))
- console.print("All information provided here will be stored only on your local machine.\n")
-
- model_options = []
-
- # Create sections for each provider
- providers: list[dict[str, Any]] = [
- {
- "name": "OpenAI",
- "env_key": "ENABLE_OPENAI",
- "api_key_env": "OPENAI_API_KEY",
- "models": [
- "OPENAI_GPT4_1",
- "OPENAI_GPT4_1_MINI",
- "OPENAI_GPT4_1_NANO",
- "OPENAI_GPT4O",
- "OPENAI_O4_MINI",
- "OPENAI_O3",
- ],
- "setup_message": "To enable OpenAI, you need an API key from your OpenAI account.",
- },
- {
- "name": "Anthropic",
- "env_key": "ENABLE_ANTHROPIC",
- "api_key_env": "ANTHROPIC_API_KEY",
- "models": ["ANTHROPIC_CLAUDE3.5_SONNET", "ANTHROPIC_CLAUDE3.7_SONNET"],
- "setup_message": "To enable Anthropic, you need an API key from your Anthropic account.",
- },
- {
- "name": "Azure OpenAI",
- "env_key": "ENABLE_AZURE",
- "api_key_env": "AZURE_API_KEY",
- "models": ["AZURE_OPENAI_GPT4O"],
- "setup_message": "To enable Azure OpenAI, you need deployment details from your Azure account.",
- "extra_fields": {
- "AZURE_DEPLOYMENT": "Enter your Azure deployment name",
- "AZURE_API_BASE": "Enter your Azure API base URL",
- "AZURE_API_VERSION": "Enter your Azure API version",
- },
- },
- {
- "name": "Google Gemini",
- "env_key": "ENABLE_GEMINI",
- "api_key_env": "GEMINI_API_KEY",
- "models": [
- "GEMINI_FLASH_2_0",
- "GEMINI_FLASH_2_0_LITE",
- "GEMINI_2.5_PRO_PREVIEW_03_25",
- "GEMINI_2.5_PRO_EXP_03_25",
- ],
- "setup_message": "To enable Gemini, you need an API key from Google AI Studio.",
- },
- {
- "name": "Novita AI",
- "env_key": "ENABLE_NOVITA",
- "api_key_env": "NOVITA_API_KEY",
- "models": [
- "NOVITA_DEEPSEEK_R1",
- "NOVITA_DEEPSEEK_V3",
- "NOVITA_LLAMA_3_3_70B",
- "NOVITA_LLAMA_3_2_1B",
- "NOVITA_LLAMA_3_2_3B",
- "NOVITA_LLAMA_3_2_11B_VISION",
- "NOVITA_LLAMA_3_1_8B",
- "NOVITA_LLAMA_3_1_70B",
- "NOVITA_LLAMA_3_1_405B",
- "NOVITA_LLAMA_3_8B",
- "NOVITA_LLAMA_3_70B",
- ],
- "setup_message": "To enable Novita AI, you need an API key from Novita.",
- },
- {
- "name": "OpenAI-compatible",
- "env_key": "ENABLE_OPENAI_COMPATIBLE",
- "models": ["OPENAI_COMPATIBLE"],
- "setup_message": "To enable an OpenAI-compatible provider, you need provider-specific details.",
- "extra_fields": {
- "OPENAI_COMPATIBLE_MODEL_NAME": "Enter the model name (e.g., 'yi-34b', 'mistral-large')",
- "OPENAI_COMPATIBLE_API_KEY": "Enter your API key",
- "OPENAI_COMPATIBLE_API_BASE": "Enter the API base URL (e.g., 'https://api.together.xyz/v1')",
- },
- "extra_questions": [
- {
- "question": "Does this model support vision?",
- "env_key": "OPENAI_COMPATIBLE_SUPPORTS_VISION",
- "value_if_yes": "true",
- "value_if_no": "false",
- }
- ],
- "optional_fields": {"OPENAI_COMPATIBLE_API_VERSION": "Enter API version (optional, press enter to skip)"},
- },
- ]
-
- # Process each provider
- for provider in providers:
- console.print(f"\n[bold yellow]{provider['name']}[/]")
- console.print(provider["setup_message"])
-
- enable = typer.confirm(f"Enable {provider['name']}?", default=False)
- update_or_add_env_var(provider["env_key"], "true" if enable else "false")
-
- if enable:
- # Handle API key (most providers)
- if "api_key_env" in provider:
- api_key = typer.prompt(f"Enter your {provider['name']} API key", hide_input=True)
- if not api_key:
- console.print(f"[bold red]Error:[/] {provider['name']} API key is required.")
- console.print(f"{provider['name']} will not be enabled.")
- update_or_add_env_var(provider["env_key"], "false")
- continue
- update_or_add_env_var(provider["api_key_env"], api_key)
-
- # Handle extra fields (Azure, OpenAI-compatible)
- if "extra_fields" in provider:
- field_values = {}
- for env_key, prompt_text in provider["extra_fields"].items():
- value = typer.prompt(prompt_text)
- field_values[env_key] = value
- update_or_add_env_var(env_key, value)
-
- # Check if all required fields are provided
- if any(not v for v in field_values.values()):
- console.print(f"[bold red]Error:[/] All {provider['name']} fields must be populated.")
- console.print(f"{provider['name']} will not be enabled.")
- update_or_add_env_var(provider["env_key"], "false")
- continue
-
- # Handle extra yes/no questions
- if "extra_questions" in provider:
- for question in provider["extra_questions"]:
- answer = typer.confirm(question["question"], default=False)
- value = question["value_if_yes"] if answer else question["value_if_no"]
- update_or_add_env_var(question["env_key"], value)
-
- # Handle optional fields
- if "optional_fields" in provider:
- for env_key, prompt_text in provider["optional_fields"].items():
- value = typer.prompt(prompt_text, default="")
- if value:
- update_or_add_env_var(env_key, value)
-
- # Add models to options
- model_options.extend(provider["models"])
- console.print(f"[green]βœ“[/] {provider['name']} configured successfully")
-
- # Model Selection
- if not model_options:
- console.print(
- "\n[bold red]Warning:[/] No LLM providers enabled. You won't be able to run Skyvern without a provider."
- )
- else:
- console.print("\n[bold]Available LLM models based on your selections:[/]")
- for i, model in enumerate(model_options, 1):
- console.print(f" {i}. [cyan]{model}[/]")
-
- while True:
- try:
- model_choice = typer.prompt(f"Choose a model by number (1-{len(model_options)})", type=int)
- if 1 <= model_choice <= len(model_options):
- break
- console.print(f"[red]Please enter a number between 1 and {len(model_options)}[/]")
- except ValueError:
- console.print("[red]Please enter a valid number[/]")
-
- chosen_model = model_options[model_choice - 1]
- console.print(f"[green]βœ“[/] Model selected: [bold]{chosen_model}[/]")
- update_or_add_env_var("LLM_KEY", chosen_model)
-
- console.print("[green]βœ“[/] LLM provider configuration updated in .env")
-
-
-def setup_browser_config() -> tuple[str, Optional[str], Optional[str]]:
- """Configure browser settings for Skyvern with improved UI."""
- console.print(Markdown("## Browser Configuration"))
-
- browser_types = [
- {
- "id": "chromium-headless",
- "name": "Headless Chrome",
- "description": "Runs Chrome in the background (no visible window)",
- },
- {"id": "chromium-headful", "name": "Visible Chrome", "description": "Runs Chrome with a visible window"},
- {
- "id": "cdp-connect",
- "name": "Connect to Chrome",
- "description": "Connects to an existing Chrome instance with remote debugging",
- },
- ]
-
- console.print("Select browser mode:")
- for i, browser in enumerate(browser_types, 1):
- console.print(f" {i}. [bold]{browser['name']}[/] - {browser['description']}")
-
- # Get browser choice
- while True:
- try:
- choice = typer.prompt("Enter your choice (1-3)", type=int)
- if 1 <= choice <= len(browser_types):
- selected_browser = browser_types[choice - 1]["id"]
- break
- console.print(f"[red]Please enter a number between 1 and {len(browser_types)}[/]")
- except ValueError:
- console.print("[red]Please enter a valid number[/]")
-
- browser_location = None
- remote_debugging_url = None
-
- # Additional configuration for CDP connection
- if selected_browser == "cdp-connect":
- host_system = detect_os()
- default_location = get_default_chrome_location(host_system)
-
- console.print(f"\n[yellow]Default Chrome location:[/] {default_location}")
- browser_location = typer.prompt("Enter Chrome executable location", default=default_location)
-
- if not os.path.exists(browser_location):
- console.print(f"[bold yellow]Warning:[/] Chrome not found at {browser_location}")
- console.print("Please verify the location is correct")
- if not typer.confirm("Continue with this path anyway?", default=False):
- return setup_browser_config() # Start over
-
- console.print("\n[bold]Chrome Remote Debugging Setup:[/]")
- console.print("Chrome must be running with remote debugging enabled.")
- console.print("Example command: [italic]chrome --remote-debugging-port=9222[/]")
-
- default_port = "9222"
- remote_debugging_url = f"http://localhost:{default_port}"
-
- # Check if Chrome is already running with remote debugging
- parsed_url = urlparse(remote_debugging_url)
- version_url = f"{parsed_url.scheme}://{parsed_url.netloc}/json/version"
-
- console.print(f"\n[yellow]Checking for Chrome on port {default_port}...[/]")
- chrome_running = False
-
- try:
- response = requests.get(version_url, timeout=2)
- if response.status_code == 200:
- try:
- browser_info = response.json()
- console.print("[green]βœ“[/] Chrome is already running with remote debugging!")
- if "Browser" in browser_info:
- console.print(f" Browser: {browser_info['Browser']}")
- if "webSocketDebuggerUrl" in browser_info:
- console.print(f" WebSocket URL: {browser_info['webSocketDebuggerUrl']}")
- chrome_running = True
- except json.JSONDecodeError:
- console.print("[red]Port is in use, but doesn't appear to be Chrome[/]")
- except requests.RequestException:
- console.print(f"[yellow]No Chrome instance detected on {remote_debugging_url}[/]")
-
- # If Chrome isn't running, offer to start it
- if not chrome_running:
- if host_system == "darwin" or host_system == "linux":
- chrome_cmd = f'{browser_location} --remote-debugging-port={default_port} --user-data-dir="$HOME/chrome-cdp-profile" --no-first-run --no-default-browser-check'
- elif host_system == "windows" or host_system == "wsl":
- chrome_cmd = f'"{browser_location}" --remote-debugging-port={default_port} --user-data-dir="C:\\chrome-cdp-profile" --no-first-run --no-default-browser-check'
- else:
- console.print("[red]Unsupported OS for Chrome configuration[/]")
- chrome_cmd = ""
-
- if chrome_cmd:
- console.print(f"\nCommand to start Chrome: [yellow]{chrome_cmd}[/]")
-
- if typer.confirm("Start Chrome with remote debugging now?", default=True):
- console.print(f"[yellow]Starting Chrome with remote debugging on port {default_port}...[/]")
- try:
- if host_system in ["darwin", "linux"]:
- subprocess.Popen(f"nohup {chrome_cmd} > /dev/null 2>&1 &", shell=True)
- elif host_system == "windows":
- subprocess.Popen(f"start {chrome_cmd}", shell=True)
- elif host_system == "wsl":
- subprocess.Popen(f"cmd.exe /c start {chrome_cmd}", shell=True)
-
- console.print("Chrome starting...")
- console.print(f"Connecting to {remote_debugging_url}")
-
- # Wait for Chrome to start and verify connection
- with Progress(
- SpinnerColumn(), TextColumn("[progress.description]{task.description}"), console=console
- ) as progress:
- wait_task = progress.add_task("[green]Waiting for Chrome to initialize...", total=1)
- time.sleep(2)
- progress.update(wait_task, completed=1)
-
- try:
- verification_response = requests.get(version_url, timeout=5)
- if verification_response.status_code == 200:
- try:
- browser_info = verification_response.json()
- console.print(
- "[green]βœ“[/] Connection verified! Chrome is running with remote debugging"
- )
- if "Browser" in browser_info:
- console.print(f" Browser: {browser_info['Browser']}")
- except json.JSONDecodeError:
- console.print(
- "[yellow]Warning:[/] Response from Chrome debugging port is not valid JSON"
- )
- else:
- console.print(
- f"[yellow]Warning:[/] Chrome responded with status code {verification_response.status_code}"
- )
- except requests.RequestException as e:
- console.print(f"[yellow]Warning:[/] Could not verify Chrome is running: {e}")
- console.print("You may need to check Chrome manually or try a different port")
- except Exception as e:
- console.print(f"[red]Error starting Chrome:[/] {e}")
- console.print("Please start Chrome manually using the command above")
-
- # Get the debugging URL
- custom_url = typer.prompt("Enter remote debugging URL", default=remote_debugging_url)
- if custom_url:
- remote_debugging_url = custom_url
-
- console.print(f"\n[green]βœ“[/] Browser configuration complete: [bold]{selected_browser}[/]")
- return selected_browser, browser_location, remote_debugging_url
-
-
-def command_exists(command: str) -> bool:
- """Check if a command exists on the system."""
- return shutil.which(command) is not None
-
-
-def run_command(command: str, check: bool = True) -> tuple[Optional[str], Optional[int]]:
- """Run a shell command and return the output and return code."""
- try:
- result = subprocess.run(command, shell=True, check=check, capture_output=True, text=True)
- return result.stdout.strip(), result.returncode
- except subprocess.CalledProcessError as e:
- return None, e.returncode
-
-
-def is_postgres_running() -> bool:
- """Check if PostgreSQL is running locally."""
- if command_exists("pg_isready"):
- result, _ = run_command("pg_isready")
- return result is not None and "accepting connections" in result
- return False
-
-
-def database_exists(dbname: str, user: str) -> bool:
- """Check if a PostgreSQL database exists."""
- check_db_command = f'psql {dbname} -U {user} -c "\\q"'
- output, _ = run_command(check_db_command, check=False)
- return output is not None
-
-
-def create_database_and_user() -> None:
- """Create PostgreSQL database and user for Skyvern."""
- run_command("createuser skyvern")
- run_command("createdb skyvern -O skyvern")
-
-
-def is_docker_running() -> bool:
- """Check if Docker is running."""
- if not command_exists("docker"):
- return False
- _, code = run_command("docker info", check=False)
- return code == 0
-
-
-def is_postgres_running_in_docker() -> bool:
- """Check if PostgreSQL is running in Docker."""
- _, code = run_command("docker ps | grep -q postgresql-container", check=False)
- return code == 0
-
-
-def is_postgres_container_exists() -> bool:
- """Check if PostgreSQL Docker container exists."""
- _, code = run_command("docker ps -a | grep -q postgresql-container", check=False)
- return code == 0
-
-
-def update_or_add_env_var(key: str, value: str) -> None:
- """Update or add environment variable in .env file with better handling."""
- env_path = Path(".env")
- if not env_path.exists():
- env_path.touch()
- # Write default environment variables
- defaults = {
- "ENV": "local",
- "ENABLE_OPENAI": "false",
- "OPENAI_API_KEY": "",
- "ENABLE_ANTHROPIC": "false",
- "ANTHROPIC_API_KEY": "",
- "ENABLE_AZURE": "false",
- "AZURE_DEPLOYMENT": "",
- "AZURE_API_KEY": "",
- "AZURE_API_BASE": "",
- "AZURE_API_VERSION": "",
- "ENABLE_GEMINI": "false",
- "GEMINI_API_KEY": "",
- "ENABLE_NOVITA": "false",
- "NOVITA_API_KEY": "",
- "LLM_KEY": "",
- "SECONDARY_LLM_KEY": "",
- "BROWSER_TYPE": "chromium-headful",
- "MAX_SCRAPING_RETRIES": "0",
- "VIDEO_PATH": "./videos",
- "BROWSER_ACTION_TIMEOUT_MS": "5000",
- "MAX_STEPS_PER_RUN": "50",
- "LOG_LEVEL": "INFO",
- "DATABASE_STRING": "postgresql+psycopg://skyvern@localhost/skyvern",
- "PORT": "8000",
- "ANALYTICS_ID": "anonymous",
- "ENABLE_LOG_ARTIFACTS": "false",
- }
- for k, v in defaults.items():
- set_key(env_path, k, v)
-
- # Load environment to get current values
- load_dotenv(env_path)
- current_value = os.getenv(key)
-
- # Only update if value is different
- if current_value != value:
- set_key(env_path, key, value)
- # Also update in current environment
- os.environ[key] = value
-
-
-async def _setup_local_organization() -> str:
- """Set up and return the API key for the local organization."""
- skyvern_agent = Skyvern(
- base_url=settings.SKYVERN_BASE_URL,
- api_key=settings.SKYVERN_API_KEY,
- )
- organization = await skyvern_agent.get_organization()
-
- org_auth_token = await app.DATABASE.get_valid_org_auth_token(
- organization_id=organization.organization_id,
- token_type=OrganizationAuthTokenType.api,
- )
- return org_auth_token.token if org_auth_token else ""
-
-
-def get_default_chrome_location(host_system: str) -> str:
- """Get the default Chrome/Chromium location based on OS."""
- if host_system == "darwin":
- return "/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"
- elif host_system == "linux":
- # Common Linux locations
- chrome_paths = ["/usr/bin/google-chrome", "/usr/bin/chromium", "/usr/bin/chromium-browser"]
- for path in chrome_paths:
- if os.path.exists(path):
- return path
- return "/usr/bin/google-chrome" # default if not found
- elif host_system == "wsl":
- return "/mnt/c/Program Files/Google/Chrome/Application/chrome.exe"
- else:
- return "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe"
-
-
-def setup_mcp() -> None:
- """Configure MCP for different Skyvern deployments."""
- host_system = detect_os()
- path_to_env = setup_mcp_config()
-
- # Configure integrations
- integrations = [
- {
- "name": "Claude Desktop",
- "check_fn": lambda: is_claude_desktop_installed(host_system),
- "setup_fn": lambda: setup_claude_desktop_config(host_system, path_to_env),
- "not_installed_msg": "Claude Desktop is not installed. Please install it first.",
- },
- {
- "name": "Cursor Editor",
- "check_fn": lambda: is_cursor_installed(host_system),
- "setup_fn": lambda: setup_cursor_config(host_system, path_to_env),
- "not_installed_msg": "Cursor Editor is not installed. Please install it first.",
- },
- {
- "name": "Windsurf",
- "check_fn": lambda: is_windsurf_installed(host_system),
- "setup_fn": lambda: setup_windsurf_config(host_system, path_to_env),
- "not_installed_msg": "Windsurf is not installed. Please install it first.",
- },
- ]
-
- # Set up each integration
- for integration in integrations:
- console.print(f"\n[bold]Setting up {integration['name']}[/]")
-
- # Check if installed
- check_fn = cast(Callable[[], bool], integration["check_fn"])
- if not check_fn():
- console.print(f"[yellow]![/] {integration['not_installed_msg']}")
- console.print(f"Skipping {integration['name']} integration setup.")
- continue
-
- # Ask user if they want to set up this integration
- if typer.confirm(f"Configure {integration['name']} integration?", default=True):
- # Set up the integration
- setup_fn = cast(Callable[[], bool], integration["setup_fn"])
- if setup_fn():
- console.print(f"[green]βœ“[/] {integration['name']} integration configured successfully")
- else:
- console.print(f"[red]Γ—[/] Error configuring {integration['name']} integration")
- else:
- console.print(f"Skipping {integration['name']} integration setup")
-
- console.print("\n[green]βœ“[/] MCP integration setup complete")
-
-
-def setup_mcp_config() -> str:
- """Find or prompt for the Python executable path and return it."""
- # Try to find Python
- python_paths = []
- for python_cmd in ["python", "python3.11"]:
- python_path = shutil.which(python_cmd)
- if python_path:
- python_paths.append((python_cmd, python_path))
-
- if not python_paths:
- console.print("[yellow]![/] Could not find Python 3.11 installation")
- path_to_env = typer.prompt(
- "Enter the full path to your Python 3.11 environment", default="/opt/homebrew/bin/python3.11"
- )
- else:
- # Show found Python installations
- console.print("[green]βœ“[/] Found Python installations:")
- for i, (cmd, path) in enumerate(python_paths, 1):
- console.print(f" {i}. {cmd}: {path}")
-
- # Use the first one as default
- _, default_path = python_paths[0]
- path_to_env = default_path
-
- if len(python_paths) > 1:
- # Let user choose if multiple were found
- choice = typer.prompt("Which Python installation do you want to use? (Enter number)", default="1")
- try:
- index = int(choice) - 1
- if 0 <= index < len(python_paths):
- _, path_to_env = python_paths[index]
- except ValueError:
- console.print(f"[yellow]![/] Invalid choice, using default: {path_to_env}")
-
- return path_to_env
-
-
-def is_claude_desktop_installed(host_system: str) -> bool:
- """Check if Claude Desktop is installed."""
- try:
- config_path = os.path.dirname(get_claude_config_path(host_system))
- return os.path.exists(config_path)
- except Exception:
- return False
-
-
-def get_claude_config_path(host_system: str) -> str:
- """Get the Claude Desktop config file path."""
- if host_system == "wsl":
- roaming_path = get_windows_appdata_roaming()
- if roaming_path is None:
- raise RuntimeError("Could not locate Windows AppData\\Roaming path from WSL")
- return os.path.join(str(roaming_path), ".cursor", "mcp.json")
-
- base_paths = {
- "darwin": ["~/Library/Application Support/Claude"],
- "linux": ["~/.config/Claude", "~/.local/share/Claude", "~/Claude"],
- }
-
- if host_system == "darwin":
- base_path = os.path.expanduser(base_paths["darwin"][0])
- return os.path.join(base_path, "claude_desktop_config.json")
-
- if host_system == "linux":
- for path in base_paths["linux"]:
- full_path = os.path.expanduser(path)
- if os.path.exists(full_path):
- return os.path.join(full_path, "claude_desktop_config.json")
-
- raise Exception(f"Unsupported host system: {host_system}")
-
-
-def setup_claude_desktop_config(host_system: str, path_to_env: str) -> bool:
- """Set up Claude Desktop configuration."""
- try:
- path_claude_config = get_claude_config_path(host_system)
- os.makedirs(os.path.dirname(path_claude_config), exist_ok=True)
-
- if not os.path.exists(path_claude_config):
- with open(path_claude_config, "w") as f:
- json.dump({"mcpServers": {}}, f, indent=2)
-
- # Read environment variables from .env file
- load_dotenv(".env")
- skyvern_base_url = os.environ.get("SKYVERN_BASE_URL", "")
- skyvern_api_key = os.environ.get("SKYVERN_API_KEY", "")
-
- if not skyvern_base_url or not skyvern_api_key:
- console.print("[red]Γ—[/] SKYVERN_BASE_URL and SKYVERN_API_KEY must be set in .env file")
- return False
-
- with open(path_claude_config, "r") as f:
- claude_config = json.load(f)
- claude_config["mcpServers"].pop("Skyvern", None)
- claude_config["mcpServers"]["Skyvern"] = {
- "env": {
- "SKYVERN_BASE_URL": skyvern_base_url,
- "SKYVERN_API_KEY": skyvern_api_key,
- },
- "command": path_to_env,
- "args": ["-m", "skyvern", "run", "mcp"],
- }
-
- with open(path_claude_config, "w") as f:
- json.dump(claude_config, f, indent=2)
-
- return True
- except Exception as e:
- console.print(f"[red]Γ—[/] Error configuring Claude Desktop: {e}")
- return False
-
-
-def is_cursor_installed(host_system: str) -> bool:
- """Check if Cursor is installed."""
- try:
- config_dir = os.path.expanduser("~/.cursor")
- return os.path.exists(config_dir)
- except Exception:
- return False
-
-
-def setup_cursor_config(host_system: str, path_to_env: str) -> bool:
- """Placeholder setup for Cursor integration."""
- console.print("[yellow]![/] Cursor integration setup is not implemented yet")
- return False
-
-
-def is_windsurf_installed(host_system: str) -> bool:
- """Check if Windsurf is installed."""
- # TODO: Implement actual detection logic
- return False
-
+setup_app.command(name="mcp")(setup_mcp_command)
+cli_app.command(name="init")(init)
-def setup_windsurf_config(host_system: str, path_to_env: str) -> bool:
- """Placeholder setup for Windsurf integration."""
- console.print("[yellow]![/] Windsurf integration setup is not implemented yet")
- return False
+if __name__ == "__main__": # pragma: no cover - manual CLI invocation
+ load_dotenv()
+ cli_app()
diff --git a/skyvern/cli/console.py b/skyvern/cli/console.py
new file mode 100644
index 000000000..806927a74
--- /dev/null
+++ b/skyvern/cli/console.py
@@ -0,0 +1,4 @@
+from rich.console import Console
+
+# Global console instance for CLI modules
+console = Console()
diff --git a/skyvern/cli/database.py b/skyvern/cli/database.py
new file mode 100644
index 000000000..f780e24f2
--- /dev/null
+++ b/skyvern/cli/database.py
@@ -0,0 +1,150 @@
+import shutil
+import subprocess
+import time
+from typing import Optional
+
+from rich.panel import Panel
+from rich.progress import Progress, SpinnerColumn, TextColumn
+from rich.prompt import Confirm
+
+from .console import console
+
+
+def command_exists(command: str) -> bool:
+ return shutil.which(command) is not None
+
+
+def run_command(command: str, check: bool = True) -> tuple[Optional[str], Optional[int]]:
+ try:
+ result = subprocess.run(command, shell=True, check=check, capture_output=True, text=True)
+ return result.stdout.strip(), result.returncode
+ except subprocess.CalledProcessError as e:
+ console.print(f"[red]Error executing command: [bold]{command}[/bold][/red]", style="red")
+ console.print(f"[red]Stderr: {e.stderr.strip()}[/red]", style="red")
+ return None, e.returncode
+
+
+def is_postgres_running() -> bool:
+ if command_exists("pg_isready"):
+ with console.status("[bold green]Checking PostgreSQL status...") as status:
+ result, _ = run_command("pg_isready")
+ if result is not None and "accepting connections" in result:
+ status.stop()
+ return True
+ status.stop()
+ return False
+ return False
+
+
+def database_exists(dbname: str, user: str) -> bool:
+ check_db_command = f'psql {dbname} -U {user} -c "\\q"'
+ output, _ = run_command(check_db_command, check=False)
+ return output is not None
+
+
+def create_database_and_user() -> None:
+ console.print("πŸš€ [bold green]Creating database user and database...[/bold green]")
+ run_command("createuser skyvern")
+ run_command("createdb skyvern -O skyvern")
+ console.print("βœ… [bold green]Database and user created successfully.[/bold green]")
+
+
+def is_docker_running() -> bool:
+ if not command_exists("docker"):
+ return False
+ _, code = run_command("docker info", check=False)
+ return code == 0
+
+
+def is_postgres_running_in_docker() -> bool:
+ _, code = run_command("docker ps | grep -q postgresql-container", check=False)
+ return code == 0
+
+
+def is_postgres_container_exists() -> bool:
+ _, code = run_command("docker ps -a | grep -q postgresql-container", check=False)
+ return code == 0
+
+
+def setup_postgresql(no_postgres: bool = False) -> None:
+ """Set up PostgreSQL database for Skyvern."""
+ console.print(Panel("[bold cyan]PostgreSQL Setup[/bold cyan]", border_style="blue"))
+
+ if command_exists("psql") and is_postgres_running():
+ console.print("✨ [green]PostgreSQL is already running locally.[/green]")
+ if database_exists("skyvern", "skyvern"):
+ console.print("βœ… [green]Database and user exist.[/green]")
+ else:
+ create_database_and_user()
+ return
+
+ if no_postgres:
+ console.print("[yellow]Skipping PostgreSQL container setup as requested.[/yellow]")
+ console.print(
+ "[italic]If you plan to use Docker Compose, its Postgres service will start automatically.[/italic]"
+ )
+ return
+
+ if not is_docker_running():
+ console.print(
+ "[red]Docker is not running or not installed. Please install or start Docker and try again.[/red]"
+ )
+ raise SystemExit(1)
+
+ if is_postgres_running_in_docker():
+ console.print("🐳 [green]PostgreSQL is already running in a Docker container.[/green]")
+ else:
+ if not no_postgres:
+ start_postgres = Confirm.ask(
+ "[yellow]No local Postgres detected. Start a disposable container now?[/yellow]\n"
+ '[tip: choose "n" if you plan to run Skyvern via Docker Compose instead of `skyvern run server`]'
+ )
+ if not start_postgres:
+ console.print("[yellow]Skipping PostgreSQL container setup.[/yellow]")
+ console.print(
+ "[italic]If you plan to use Docker Compose, its Postgres service will start automatically.[/italic]"
+ )
+ return
+
+ console.print("πŸš€ [bold green]Attempting to install PostgreSQL via Docker...[/bold green]")
+ if not is_postgres_container_exists():
+ with console.status("[bold blue]Pulling and starting PostgreSQL container...[/bold blue]"):
+ run_command(
+ "docker run --name postgresql-container -e POSTGRES_HOST_AUTH_METHOD=trust -d -p 5432:5432 postgres:14"
+ )
+ console.print("βœ… [green]PostgreSQL has been installed and started using Docker.[/green]")
+ else:
+ with console.status("[bold blue]Starting existing PostgreSQL container...[/bold blue]"):
+ run_command("docker start postgresql-container")
+ console.print("βœ… [green]Existing PostgreSQL container started.[/green]")
+
+ with Progress(
+ SpinnerColumn(), TextColumn("[progress.description]{task.description}"), transient=True, console=console
+ ) as progress:
+ progress.add_task("[bold blue]Waiting for PostgreSQL to become ready...", total=None)
+ time.sleep(20)
+
+ console.print("βœ… [green]PostgreSQL container ready.[/green]")
+
+ with console.status("[bold green]Checking database user...[/bold green]"):
+ _, code = run_command(
+ 'docker exec postgresql-container psql -U postgres -c "\\du" | grep -q skyvern', check=False
+ )
+ if code == 0:
+ console.print("βœ… [green]Database user exists.[/green]")
+ else:
+ console.print("πŸš€ [bold green]Creating database user...[/bold green]")
+ run_command("docker exec postgresql-container createuser -U postgres skyvern")
+ console.print("βœ… [green]Database user created.[/green]")
+
+ with console.status("[bold green]Checking database...[/bold green]"):
+ _, code = run_command(
+ "docker exec postgresql-container psql -U postgres -lqt | cut -d | -f 1 | grep -qw skyvern",
+ check=False,
+ )
+ if code == 0:
+ console.print("βœ… [green]Database exists.[/green]")
+ else:
+ console.print("πŸš€ [bold green]Creating database...[/bold green]")
+ run_command("docker exec postgresql-container createdb -U postgres skyvern -O skyvern")
+ console.print("βœ… [green]Database and user created successfully.[/green]")
diff --git a/skyvern/cli/docs.py b/skyvern/cli/docs.py
new file mode 100644
index 000000000..c026c967c
--- /dev/null
+++ b/skyvern/cli/docs.py
@@ -0,0 +1,13 @@
+"""Documentation-related CLI helpers."""
+
+import typer
+
+from .console import console
+
+docs_app = typer.Typer()
+
+
+@docs_app.command()
+def placeholder() -> None:
+ """Placeholder command for documentation actions."""
+ console.print("Documentation commands are not yet implemented.")
diff --git a/skyvern/cli/init_command.py b/skyvern/cli/init_command.py
new file mode 100644
index 000000000..492bfaa3f
--- /dev/null
+++ b/skyvern/cli/init_command.py
@@ -0,0 +1,124 @@
+import asyncio
+import os
+import subprocess
+import uuid
+
+import typer
+from rich.padding import Padding
+from rich.panel import Panel
+from rich.progress import Progress, SpinnerColumn, TextColumn
+from rich.prompt import Confirm, Prompt
+
+from skyvern.utils import migrate_db
+
+from .browser import setup_browser_config
+from .console import console
+from .database import setup_postgresql
+from .llm_setup import setup_llm_providers, update_or_add_env_var
+from .mcp import setup_local_organization, setup_mcp
+
+
+def init(
+ no_postgres: bool = typer.Option(False, "--no-postgres", help="Skip starting PostgreSQL container"),
+) -> None:
+ """Interactive initialization command for Skyvern."""
+ console.print(
+ Panel(
+ "[bold green]Welcome to Skyvern CLI Initialization![/bold green]",
+ border_style="green",
+ expand=False,
+ )
+ )
+ console.print("[italic]This wizard will help you set up Skyvern.[/italic]")
+
+ run_local = Confirm.ask(
+ "Would you like to run Skyvern [bold blue]locally[/bold blue] or in the [bold purple]cloud[/bold purple]?",
+ default=False,
+ choices=["local", "cloud"],
+ )
+
+ if run_local:
+ setup_postgresql(no_postgres)
+ console.print("πŸ“Š [bold blue]Running database migrations...[/bold blue]")
+ migrate_db()
+ console.print("βœ… [green]Database migration complete.[/green]")
+
+ console.print("πŸ”‘ [bold blue]Generating local organization API key...[/bold blue]")
+ api_key = asyncio.run(setup_local_organization())
+ if api_key:
+ console.print("βœ… [green]Local organization API key generated.[/green]")
+ else:
+ console.print("[red]Failed to generate local organization API key. Please check server logs.[/red]")
+
+ if os.path.exists(".env"):
+ console.print("πŸ’‘ [.env] file already exists.", style="yellow")
+ redo_llm_setup = Confirm.ask(
+ "Do you want to go through [bold yellow]LLM provider setup again[/bold yellow]?",
+ default=False,
+ )
+ if not redo_llm_setup:
+ console.print("[green]Skipping LLM setup.[/green]")
+ else:
+ console.print("\n[bold blue]Initializing .env file for LLM providers...[/bold blue]")
+ setup_llm_providers()
+ else:
+ console.print("\n[bold blue]Initializing .env file...[/bold blue]")
+ setup_llm_providers()
+
+ console.print("\n[bold blue]Configuring browser settings...[/bold blue]")
+ browser_type, browser_location, remote_debugging_url = setup_browser_config()
+ update_or_add_env_var("BROWSER_TYPE", browser_type)
+ if browser_location:
+ update_or_add_env_var("CHROME_EXECUTABLE_PATH", browser_location)
+ if remote_debugging_url:
+ update_or_add_env_var("BROWSER_REMOTE_DEBUGGING_URL", remote_debugging_url)
+ console.print("βœ… [green]Browser configuration complete.[/green]")
+
+ console.print("🌐 [bold blue]Setting Skyvern Base URL to: http://localhost:8000[/bold blue]")
+ update_or_add_env_var("SKYVERN_BASE_URL", "http://localhost:8000")
+
+ else:
+ console.print(Panel("[bold purple]Cloud Deployment Setup[/bold purple]", border_style="purple"))
+ base_url = Prompt.ask("Enter Skyvern base URL", default="https://api.skyvern.com", show_default=True)
+ if not base_url:
+ base_url = "https://api.skyvern.com"
+
+ console.print("\n[bold]To get your API key:[/bold]")
+ console.print("1. Create an account at [link]https://app.skyvern.com[/link]")
+ console.print("2. Go to [bold cyan]Settings[/bold cyan]")
+ console.print("3. [bold green]Copy your API key[/bold green]")
+ api_key = Prompt.ask("Enter your Skyvern API key", password=True)
+ if not api_key:
+ console.print("[red]API key is required.[/red]")
+ api_key = Prompt.ask("Please re-enter your Skyvern API key", password=True)
+ if not api_key:
+ console.print("[bold red]Error: API key cannot be empty. Aborting initialization.[/bold red]")
+ return
+ update_or_add_env_var("SKYVERN_BASE_URL", base_url)
+
+ analytics_id_input = Prompt.ask("Please enter your email for analytics (press enter to skip)", default="")
+ analytics_id = analytics_id_input if analytics_id_input else str(uuid.uuid4())
+ update_or_add_env_var("ANALYTICS_ID", analytics_id)
+ update_or_add_env_var("SKYVERN_API_KEY", api_key)
+ console.print("βœ… [green].env file has been initialized.[/green]")
+
+ if Confirm.ask("\nWould you like to [bold yellow]configure the MCP server[/bold yellow]?", default=True):
+ setup_mcp()
+
+ if not run_local:
+ console.print(
+ "\nπŸŽ‰ [bold green]MCP configuration is complete! Your AI applications are now ready to use Skyvern Cloud.[/bold green]"
+ )
+
+ if run_local:
+ console.print("\n⬇️ [bold blue]Installing Chromium browser...[/bold blue]")
+ with Progress(
+ SpinnerColumn(), TextColumn("[progress.description]{task.description}"), transient=True, console=console
+ ) as progress:
+ progress.add_task("[bold blue]Downloading Chromium, this may take a moment...", total=None)
+ subprocess.run(["playwright", "install", "chromium"], check=True)
+ console.print("βœ… [green]Chromium installation complete.[/green]")
+
+ console.print("\nπŸŽ‰ [bold green]Skyvern setup complete![/bold green]")
+ console.print("[bold]To start using Skyvern, run:[/bold]")
+ console.print(Padding("skyvern run server", (1, 4), style="reverse green"))
diff --git a/skyvern/cli/llm_setup.py b/skyvern/cli/llm_setup.py
new file mode 100644
index 000000000..c919c3833
--- /dev/null
+++ b/skyvern/cli/llm_setup.py
@@ -0,0 +1,213 @@
+from pathlib import Path
+
+from dotenv import load_dotenv, set_key
+from rich.panel import Panel
+from rich.prompt import Confirm, Prompt
+
+from .console import console
+
+
+def update_or_add_env_var(key: str, value: str) -> None:
+ """Update or add environment variable in .env file."""
+ env_path = Path(".env")
+ if not env_path.exists():
+ env_path.touch()
+ defaults = {
+ "ENV": "local",
+ "ENABLE_OPENAI": "false",
+ "OPENAI_API_KEY": "",
+ "ENABLE_ANTHROPIC": "false",
+ "ANTHROPIC_API_KEY": "",
+ "ENABLE_AZURE": "false",
+ "AZURE_DEPLOYMENT": "",
+ "AZURE_API_KEY": "",
+ "AZURE_API_BASE": "",
+ "AZURE_API_VERSION": "",
+ "ENABLE_AZURE_GPT4O_MINI": "false",
+ "AZURE_GPT4O_MINI_DEPLOYMENT": "",
+ "AZURE_GPT4O_MINI_API_KEY": "",
+ "AZURE_GPT4O_MINI_API_BASE": "",
+ "AZURE_GPT4O_MINI_API_VERSION": "",
+ "ENABLE_GEMINI": "false",
+ "GEMINI_API_KEY": "",
+ "ENABLE_NOVITA": "false",
+ "NOVITA_API_KEY": "",
+ "LLM_KEY": "",
+ "SECONDARY_LLM_KEY": "",
+ "BROWSER_TYPE": "chromium-headful",
+ "MAX_SCRAPING_RETRIES": "0",
+ "VIDEO_PATH": "./videos",
+ "BROWSER_ACTION_TIMEOUT_MS": "5000",
+ "MAX_STEPS_PER_RUN": "50",
+ "LOG_LEVEL": "INFO",
+ "DATABASE_STRING": "postgresql+psycopg://skyvern@localhost/skyvern",
+ "PORT": "8000",
+ "ANALYTICS_ID": "anonymous",
+ "ENABLE_LOG_ARTIFACTS": "false",
+ }
+ for k, v in defaults.items():
+ set_key(env_path, k, v)
+
+ load_dotenv(env_path)
+ set_key(env_path, key, value)
+
+
+def setup_llm_providers() -> None:
+ """Configure Large Language Model (LLM) Providers."""
+ console.print(Panel("[bold magenta]LLM Provider Configuration[/bold magenta]", border_style="purple"))
+ console.print("[italic]Note: All information provided here will be stored only on your local machine.[/italic]")
+ model_options: list[str] = []
+
+ console.print("\n[bold blue]--- OpenAI Configuration ---[/bold blue]")
+ console.print("To enable OpenAI, you must have an OpenAI API key.")
+ enable_openai = Confirm.ask("Do you want to enable OpenAI?")
+ if enable_openai:
+ openai_api_key = Prompt.ask("Enter your OpenAI API key", password=True)
+ if not openai_api_key:
+ console.print("[red]Error: OpenAI API key is required. OpenAI will not be enabled.[/red]")
+ else:
+ update_or_add_env_var("OPENAI_API_KEY", openai_api_key)
+ update_or_add_env_var("ENABLE_OPENAI", "true")
+ model_options.extend(
+ [
+ "OPENAI_GPT4_1",
+ "OPENAI_GPT4_1_MINI",
+ "OPENAI_GPT4_1_NANO",
+ "OPENAI_GPT4O",
+ "OPENAI_O4_MINI",
+ "OPENAI_O3",
+ ]
+ )
+ else:
+ update_or_add_env_var("ENABLE_OPENAI", "false")
+
+ console.print("\n[bold blue]--- Anthropic Configuration ---[/bold blue]")
+ console.print("To enable Anthropic, you must have an Anthropic API key.")
+ enable_anthropic = Confirm.ask("Do you want to enable Anthropic?")
+ if enable_anthropic:
+ anthropic_api_key = Prompt.ask("Enter your Anthropic API key", password=True)
+ if not anthropic_api_key:
+ console.print("[red]Error: Anthropic API key is required. Anthropic will not be enabled.[/red]")
+ else:
+ update_or_add_env_var("ANTHROPIC_API_KEY", anthropic_api_key)
+ update_or_add_env_var("ENABLE_ANTHROPIC", "true")
+ model_options.extend(
+ [
+ "ANTHROPIC_CLAUDE3.5_SONNET",
+ "ANTHROPIC_CLAUDE3.7_SONNET",
+ ]
+ )
+ else:
+ update_or_add_env_var("ENABLE_ANTHROPIC", "false")
+
+ console.print("\n[bold blue]--- Azure Configuration ---[/bold blue]")
+ console.print("To enable Azure, you must have an Azure deployment name, API key, base URL, and API version.")
+ enable_azure = Confirm.ask("Do you want to enable Azure?")
+ if enable_azure:
+ azure_deployment = Prompt.ask("Enter your Azure deployment name")
+ azure_api_key = Prompt.ask("Enter your Azure API key", password=True)
+ azure_api_base = Prompt.ask("Enter your Azure API base URL")
+ azure_api_version = Prompt.ask("Enter your Azure API version")
+ if not all([azure_deployment, azure_api_key, azure_api_base, azure_api_version]):
+ console.print("[red]Error: All Azure fields must be populated. Azure will not be enabled.[/red]")
+ else:
+ update_or_add_env_var("AZURE_DEPLOYMENT", azure_deployment)
+ update_or_add_env_var("AZURE_API_KEY", azure_api_key)
+ update_or_add_env_var("AZURE_API_BASE", azure_api_base)
+ update_or_add_env_var("AZURE_API_VERSION", azure_api_version)
+ update_or_add_env_var("ENABLE_AZURE", "true")
+ model_options.append("AZURE_OPENAI_GPT4O")
+ else:
+ update_or_add_env_var("ENABLE_AZURE", "false")
+
+ console.print("\n[bold blue]--- Gemini Configuration ---[/bold blue]")
+ console.print("To enable Gemini, you must have a Gemini API key.")
+ enable_gemini = Confirm.ask("Do you want to enable Gemini?")
+ if enable_gemini:
+ gemini_api_key = Prompt.ask("Enter your Gemini API key", password=True)
+ if not gemini_api_key:
+ console.print("[red]Error: Gemini API key is required. Gemini will not be enabled.[/red]")
+ else:
+ update_or_add_env_var("GEMINI_API_KEY", gemini_api_key)
+ update_or_add_env_var("ENABLE_GEMINI", "true")
+ else:
+ update_or_add_env_var("ENABLE_GEMINI", "false")
+
+ console.print("\n[bold blue]--- Novita Configuration ---[/bold blue]")
+ console.print("To enable Novita, you must have a Novita API key.")
+ enable_novita = Confirm.ask("Do you want to enable Novita?")
+ if enable_novita:
+ novita_api_key = Prompt.ask("Enter your Novita API key", password=True)
+ if not novita_api_key:
+ console.print("[red]Error: Novita API key is required. Novita will not be enabled.[/red]")
+ else:
+ update_or_add_env_var("NOVITA_API_KEY", novita_api_key)
+ update_or_add_env_var("ENABLE_NOVITA", "true")
+ model_options.extend(
+ [
+ "NOVITA_LLAMA_3_2_11B_VISION",
+ "NOVITA_LLAMA_3_1_8B",
+ "NOVITA_LLAMA_3_1_70B",
+ "NOVITA_LLAMA_3_1_405B",
+ "NOVITA_LLAMA_3_8B",
+ "NOVITA_LLAMA_3_70B",
+ ]
+ )
+ else:
+ update_or_add_env_var("ENABLE_NOVITA", "false")
+
+ console.print("\n[bold blue]--- OpenAI-Compatible Provider Configuration ---[/bold blue]")
+ console.print("To enable an OpenAI-compatible provider, you must have a model name, API key, and API base URL.")
+ enable_openai_compatible = Confirm.ask("Do you want to enable an OpenAI-compatible provider?")
+ if enable_openai_compatible:
+ openai_compatible_model_name = Prompt.ask("Enter the model name (e.g., 'yi-34b', 'mistral-large')")
+ openai_compatible_api_key = Prompt.ask("Enter your API key", password=True)
+ openai_compatible_api_base = Prompt.ask("Enter the API base URL (e.g., 'https://api.together.xyz/v1')")
+ openai_compatible_vision = Confirm.ask("Does this model support vision?")
+
+ if not all([openai_compatible_model_name, openai_compatible_api_key, openai_compatible_api_base]):
+ console.print(
+ "[red]Error: All required fields must be populated. OpenAI-compatible provider will not be enabled.[/red]"
+ )
+ else:
+ update_or_add_env_var("OPENAI_COMPATIBLE_MODEL_NAME", openai_compatible_model_name)
+ update_or_add_env_var("OPENAI_COMPATIBLE_API_KEY", openai_compatible_api_key)
+ update_or_add_env_var("OPENAI_COMPATIBLE_API_BASE", openai_compatible_api_base)
+ if openai_compatible_vision:
+ update_or_add_env_var("OPENAI_COMPATIBLE_SUPPORTS_VISION", "true")
+ else:
+ update_or_add_env_var("OPENAI_COMPATIBLE_SUPPORTS_VISION", "false")
+
+ openai_compatible_api_version = Prompt.ask("Enter API version (optional, press enter to skip)", default="")
+ if openai_compatible_api_version:
+ update_or_add_env_var("OPENAI_COMPATIBLE_API_VERSION", openai_compatible_api_version)
+
+ update_or_add_env_var("ENABLE_OPENAI_COMPATIBLE", "true")
+ model_options.append("OPENAI_COMPATIBLE")
+ else:
+ update_or_add_env_var("ENABLE_OPENAI_COMPATIBLE", "false")
+
+ if not model_options:
+ console.print(
+ Panel(
+ "[bold red]No LLM providers enabled.[/bold red]\n"
+ "You won't be able to run Skyvern unless you enable at least one provider.\n"
+ "You can re-run this script to enable providers or manually update the .env file.",
+ border_style="red",
+ )
+ )
+ else:
+ console.print("\n[bold green]Available LLM models based on your selections:[/bold green]")
+ for i, model in enumerate(model_options, 1):
+ console.print(f" [cyan]{i}.[/cyan] [green]{model}[/green]")
+
+ chosen_model_idx = Prompt.ask(
+ f"Choose a model by number (e.g., [cyan]1[/cyan] for [green]{model_options[0]}[/green])",
+ choices=[str(i) for i in range(1, len(model_options) + 1)],
+ default="1",
+ )
+ chosen_model = model_options[int(chosen_model_idx) - 1]
+ console.print(f"πŸŽ‰ [bold green]Chosen LLM Model: {chosen_model}[/bold green]")
+ update_or_add_env_var("LLM_KEY", chosen_model)
+
+ console.print("βœ… [green]LLM provider configurations updated in .env.[/green]")
diff --git a/skyvern/cli/mcp.py b/skyvern/cli/mcp.py
new file mode 100644
index 000000000..3b7a9d2d6
--- /dev/null
+++ b/skyvern/cli/mcp.py
@@ -0,0 +1,277 @@
+import json
+import os
+import shutil
+
+from dotenv import load_dotenv
+from rich.panel import Panel
+from rich.prompt import Confirm, Prompt
+
+from skyvern.config import settings
+from skyvern.forge import app
+from skyvern.forge.sdk.db.enums import OrganizationAuthTokenType
+from skyvern.library import Skyvern
+from skyvern.utils import detect_os, get_windows_appdata_roaming
+
+from .console import console
+
+
+async def setup_local_organization() -> str:
+ skyvern_agent = Skyvern(base_url=settings.SKYVERN_BASE_URL, api_key=settings.SKYVERN_API_KEY)
+ organization = await skyvern_agent.get_organization()
+ org_auth_token = await app.DATABASE.get_valid_org_auth_token(
+ organization_id=organization.organization_id,
+ token_type=OrganizationAuthTokenType.api,
+ )
+ return org_auth_token.token if org_auth_token else ""
+
+
+# ----- Helper paths and checks -----
+
+
+def get_claude_config_path(host_system: str) -> str:
+ if host_system == "wsl":
+ roaming_path = get_windows_appdata_roaming()
+ if roaming_path is None:
+ raise RuntimeError("Could not locate Windows AppData\\Roaming path from WSL")
+ return os.path.join(str(roaming_path), "Claude", "claude_desktop_config.json")
+ base_paths = {
+ "darwin": ["~/Library/Application Support/Claude"],
+ "linux": ["~/.config/Claude", "~/.local/share/Claude", "~/Claude"],
+ }
+ if host_system == "darwin":
+ return os.path.join(os.path.expanduser(base_paths["darwin"][0]), "claude_desktop_config.json")
+ if host_system == "linux":
+ for path in base_paths["linux"]:
+ full = os.path.expanduser(path)
+ if os.path.exists(full):
+ return os.path.join(full, "claude_desktop_config.json")
+ raise Exception(f"Unsupported host system: {host_system}")
+
+
+def get_cursor_config_path(host_system: str) -> str:
+ if host_system == "wsl":
+ roaming_path = get_windows_appdata_roaming()
+ if roaming_path is None:
+ raise RuntimeError("Could not locate Windows AppData\\Roaming path from WSL")
+ return os.path.join(str(roaming_path), ".cursor", "mcp.json")
+ return os.path.expanduser("~/.cursor/mcp.json")
+
+
+def get_windsurf_config_path(host_system: str) -> str:
+ return os.path.expanduser("~/.codeium/windsurf/mcp_config.json")
+
+
+# ----- Setup Helpers -----
+
+
+def setup_mcp_config() -> str:
+ console.print(Panel("[bold yellow]Setting up MCP Python Environment[/bold yellow]", border_style="yellow"))
+ python_paths: list[tuple[str, str]] = []
+ for python_cmd in ["python", "python3.11"]:
+ python_path = shutil.which(python_cmd)
+ if python_path:
+ python_paths.append((python_cmd, python_path))
+
+ if not python_paths:
+ console.print("[red]Error: Could not find any Python installation. Please install Python 3.11 first.[/red]")
+ path_to_env = Prompt.ask(
+ "Enter the full path to your python 3.11 environment. For example in MacOS if you installed it using Homebrew, it would be [cyan]/opt/homebrew/bin/python3.11[/cyan]"
+ )
+ else:
+ _, default_path = python_paths[0]
+ console.print(f"πŸ’‘ [italic]Detected Python environment:[/italic] [green]{default_path}[/green]")
+ path_to_env = default_path
+ return path_to_env
+
+
+def is_cursor_installed(host_system: str) -> bool:
+ try:
+ config_dir = os.path.expanduser("~/.cursor")
+ return os.path.exists(config_dir)
+ except Exception:
+ return False
+
+
+def is_claude_desktop_installed(host_system: str) -> bool:
+ try:
+ config_path = os.path.dirname(get_claude_config_path(host_system))
+ return os.path.exists(config_path)
+ except Exception:
+ return False
+
+
+def is_windsurf_installed(host_system: str) -> bool:
+ try:
+ config_dir = os.path.expanduser("~/.codeium/windsurf")
+ return os.path.exists(config_dir)
+ except Exception:
+ return False
+
+
+def setup_claude_desktop_config(host_system: str, path_to_env: str) -> bool:
+ console.print(Panel("[bold blue]Configuring Claude Desktop MCP[/bold blue]", border_style="blue"))
+ if not is_claude_desktop_installed(host_system):
+ console.print("[yellow]Claude Desktop is not installed. Please install it first.[/yellow]")
+ return False
+
+ try:
+ path_claude_config = get_claude_config_path(host_system)
+ os.makedirs(os.path.dirname(path_claude_config), exist_ok=True)
+ if not os.path.exists(path_claude_config):
+ with open(path_claude_config, "w") as f:
+ json.dump({"mcpServers": {}}, f, indent=2)
+
+ load_dotenv(".env")
+ skyvern_base_url = os.environ.get("SKYVERN_BASE_URL", "")
+ skyvern_api_key = os.environ.get("SKYVERN_API_KEY", "")
+ if not skyvern_base_url or not skyvern_api_key:
+ console.print(
+ f"[red]Error: SKYVERN_BASE_URL and SKYVERN_API_KEY must be set in .env file to set up Claude MCP. Please open {path_claude_config} and set these variables manually.[/red]"
+ )
+ return False
+
+ claude_config: dict = {"mcpServers": {}}
+ if os.path.exists(path_claude_config):
+ try:
+ with open(path_claude_config, "r") as f:
+ claude_config = json.load(f)
+ claude_config["mcpServers"].pop("Skyvern", None)
+ claude_config["mcpServers"]["Skyvern"] = {
+ "env": {"SKYVERN_BASE_URL": skyvern_base_url, "SKYVERN_API_KEY": skyvern_api_key},
+ "command": path_to_env,
+ "args": ["-m", "skyvern", "run", "mcp"],
+ }
+ except json.JSONDecodeError:
+ console.print(
+ f"[red]JSONDecodeError encountered while reading the Claude Desktop configuration. Please open {path_claude_config} and fix the JSON config.[/red]"
+ )
+ return False
+
+ with open(path_claude_config, "w") as f:
+ json.dump(claude_config, f, indent=2)
+
+ console.print(
+ f"βœ… [green]Claude Desktop MCP configuration updated successfully at [link]{path_claude_config}[/link].[/green]"
+ )
+ return True
+
+ except Exception as e:
+ console.print(f"[red]Error configuring Claude Desktop: {e}[/red]")
+ return False
+
+
+def setup_cursor_config(host_system: str, path_to_env: str) -> bool:
+ console.print(Panel("[bold blue]Configuring Cursor MCP[/bold blue]", border_style="blue"))
+ if not is_cursor_installed(host_system):
+ console.print("[yellow]Cursor is not installed. Skipping Cursor MCP setup.[/yellow]")
+ return False
+
+ try:
+ path_cursor_config = get_cursor_config_path(host_system)
+ os.makedirs(os.path.dirname(path_cursor_config), exist_ok=True)
+ if not os.path.exists(path_cursor_config):
+ with open(path_cursor_config, "w") as f:
+ json.dump({"mcpServers": {}}, f, indent=2)
+
+ load_dotenv(".env")
+ skyvern_base_url = os.environ.get("SKYVERN_BASE_URL", "")
+ skyvern_api_key = os.environ.get("SKYVERN_API_KEY", "")
+ if not skyvern_base_url or not skyvern_api_key:
+ console.print(
+ f"[red]Error: SKYVERN_BASE_URL and SKYVERN_API_KEY must be set in .env file to set up Cursor MCP. Please open [link]{path_cursor_config}[/link] and set these variables manually.[/red]"
+ )
+ return False
+
+ cursor_config: dict = {"mcpServers": {}}
+ if os.path.exists(path_cursor_config):
+ try:
+ with open(path_cursor_config, "r") as f:
+ cursor_config = json.load(f)
+ cursor_config["mcpServers"].pop("Skyvern", None)
+ cursor_config["mcpServers"]["Skyvern"] = {
+ "env": {"SKYVERN_BASE_URL": skyvern_base_url, "SKYVERN_API_KEY": skyvern_api_key},
+ "command": path_to_env,
+ "args": ["-m", "skyvern", "run", "mcp"],
+ }
+ except json.JSONDecodeError:
+ console.print(
+ f"[red]JSONDecodeError encountered while reading the Cursor configuration. Please open [link]{path_cursor_config}[/link] and fix the JSON config.[/red]"
+ )
+ return False
+
+ with open(path_cursor_config, "w") as f:
+ json.dump(cursor_config, f, indent=2)
+
+ console.print(
+ f"βœ… [green]Cursor MCP configuration updated successfully at [link]{path_cursor_config}[/link][/green]"
+ )
+ return True
+
+ except Exception as e:
+ console.print(f"[red]Error configuring Cursor: {e}[/red]")
+ return False
+
+
+def setup_windsurf_config(host_system: str, path_to_env: str) -> bool:
+ if not is_windsurf_installed(host_system):
+ return False
+
+ path_windsurf_config = get_windsurf_config_path(host_system)
+ load_dotenv(".env")
+ skyvern_base_url = os.environ.get("SKYVERN_BASE_URL", "")
+ skyvern_api_key = os.environ.get("SKYVERN_API_KEY", "")
+ if not skyvern_base_url or not skyvern_api_key:
+ console.print(
+ f"[red]Error: SKYVERN_BASE_URL and SKYVERN_API_KEY must be set in .env file to set up Windsurf MCP. Please open {path_windsurf_config} and set these variables manually.[/red]"
+ )
+
+ try:
+ os.makedirs(os.path.dirname(path_windsurf_config), exist_ok=True)
+ if not os.path.exists(path_windsurf_config):
+ with open(path_windsurf_config, "w") as f:
+ json.dump({"mcpServers": {}}, f, indent=2)
+
+ windsurf_config: dict = {"mcpServers": {}}
+ if os.path.exists(path_windsurf_config):
+ try:
+ with open(path_windsurf_config, "r") as f:
+ windsurf_config = json.load(f)
+ windsurf_config["mcpServers"].pop("Skyvern", None)
+ windsurf_config["mcpServers"]["Skyvern"] = {
+ "env": {"SKYVERN_BASE_URL": skyvern_base_url, "SKYVERN_API_KEY": skyvern_api_key},
+ "command": path_to_env,
+ "args": ["-m", "skyvern", "run", "mcp"],
+ }
+ except json.JSONDecodeError:
+ console.print(
+ f"[red]JSONDecodeError when reading Error configuring Windsurf. Please open {path_windsurf_config} and fix the json config first.[/red]"
+ )
+ return False
+
+ with open(path_windsurf_config, "w") as f:
+ json.dump(windsurf_config, f, indent=2)
+ except Exception as e:
+ console.print(f"[red]Error configuring Windsurf: {e}[/red]")
+ return False
+
+ console.print(
+ f"βœ… [green]Windsurf MCP configuration updated successfully at [link]{path_windsurf_config}[/link].[/green]"
+ )
+ return True
+
+
+def setup_mcp() -> None:
+ console.print(Panel("[bold green]MCP Server Setup[/bold green]", border_style="green"))
+ host_system = detect_os()
+ path_to_env = setup_mcp_config()
+
+ if Confirm.ask("Would you like to set up MCP integration for Claude Desktop?", default=True):
+ setup_claude_desktop_config(host_system, path_to_env)
+
+ if Confirm.ask("Would you like to set up MCP integration for Cursor?", default=True):
+ setup_cursor_config(host_system, path_to_env)
+
+ if Confirm.ask("Would you like to set up MCP integration for Windsurf?", default=True):
+ setup_windsurf_config(host_system, path_to_env)
+
+ console.print("\nπŸŽ‰ [bold green]MCP server configuration completed.[/bold green]")
diff --git a/skyvern/cli/run_commands.py b/skyvern/cli/run_commands.py
new file mode 100644
index 000000000..a88bfa504
--- /dev/null
+++ b/skyvern/cli/run_commands.py
@@ -0,0 +1,128 @@
+import os
+import shutil
+import subprocess
+from pathlib import Path
+from typing import List
+
+import psutil
+import typer
+import uvicorn
+from dotenv import load_dotenv, set_key
+from mcp.server.fastmcp import FastMCP
+from rich.panel import Panel
+from rich.prompt import Confirm
+
+from skyvern.utils import detect_os
+
+from .console import console
+
+run_app = typer.Typer()
+
+mcp = FastMCP("Skyvern")
+
+
+def get_pids_on_port(port: int) -> List[int]:
+ """Return a list of PIDs listening on the given port."""
+ pids = []
+ try:
+ for conn in psutil.net_connections(kind="inet"):
+ if conn.laddr and conn.laddr.port == port and conn.pid:
+ pids.append(conn.pid)
+ except Exception:
+ pass
+ return list(set(pids))
+
+
+def kill_pids(pids: List[int]) -> None:
+ """Kill the given list of PIDs in a cross-platform way."""
+ host_system = detect_os()
+ for pid in pids:
+ try:
+ if host_system in {"windows", "wsl"}:
+ subprocess.run(f"taskkill /PID {pid} /F", shell=True, check=False)
+ else:
+ os.kill(pid, 9)
+ except Exception:
+ console.print(f"[red]Failed to kill process {pid}[/red]")
+
+
+@run_app.command(name="server")
+def run_server() -> None:
+ """Run the Skyvern API server."""
+ load_dotenv()
+ load_dotenv(".env")
+ from skyvern.config import settings
+
+ port = settings.PORT
+ console.print(Panel(f"[bold green]Starting Skyvern API Server on port {port}...", border_style="green"))
+ uvicorn.run(
+ "skyvern.forge.api_app:app",
+ host="0.0.0.0",
+ port=port,
+ log_level="info",
+ )
+
+
+@run_app.command(name="ui")
+def run_ui() -> None:
+ """Run the Skyvern UI server."""
+ console.print(Panel("[bold blue]Starting Skyvern UI Server...[/bold blue]", border_style="blue"))
+ try:
+ with console.status("[bold green]Checking for existing process on port 8080...") as status:
+ pids = get_pids_on_port(8080)
+ if pids:
+ status.stop()
+ response = Confirm.ask("Process already running on port 8080. [yellow]Kill it?[/yellow]")
+ if response:
+ kill_pids(pids)
+ console.print("βœ… [green]Process killed.[/green]")
+ else:
+ console.print("[yellow]UI server not started. Process already running on port 8080.[/yellow]")
+ return
+ status.stop()
+ except Exception as e: # pragma: no cover - CLI safeguards
+ console.print(f"[red]Error checking for process: {e}[/red]")
+
+ current_dir = Path(__file__).parent.parent.parent
+ frontend_dir = current_dir / "skyvern-frontend"
+ if not frontend_dir.exists():
+ console.print(
+ f"[bold red]ERROR: Skyvern Frontend directory not found at [path]{frontend_dir}[/path]. Are you in the right repo?[/bold red]"
+ )
+ return
+
+ if not (frontend_dir / ".env").exists():
+ console.print("[bold blue]Setting up frontend .env file...[/bold blue]")
+ shutil.copy(frontend_dir / ".env.example", frontend_dir / ".env")
+ main_env_path = current_dir / ".env"
+ if main_env_path.exists():
+ load_dotenv(main_env_path)
+ skyvern_api_key = os.getenv("SKYVERN_API_KEY")
+ if skyvern_api_key:
+ frontend_env_path = frontend_dir / ".env"
+ set_key(str(frontend_env_path), "VITE_SKYVERN_API_KEY", skyvern_api_key)
+ else:
+ console.print("[red]ERROR: SKYVERN_API_KEY not found in .env file[/red]")
+ else:
+ console.print("[red]ERROR: .env file not found[/red]")
+
+ console.print("βœ… [green]Successfully set up frontend .env file[/green]")
+
+ os.chdir(frontend_dir)
+
+ try:
+ console.print("πŸ“¦ [bold blue]Running npm install...[/bold blue]")
+ subprocess.run("npm install --silent", shell=True, check=True)
+ console.print("βœ… [green]npm install complete.[/green]")
+ console.print("πŸš€ [bold blue]Starting npm UI server...[/bold blue]")
+ subprocess.run("npm run start", shell=True, check=True)
+ except subprocess.CalledProcessError as e:
+ console.print(f"[bold red]Error running UI server: {e}[/bold red]")
+ return
+
+
+@run_app.command(name="mcp")
+def run_mcp() -> None:
+ """Run the MCP server."""
+ console.print(Panel("[bold green]Starting MCP Server...[/bold green]", border_style="green"))
+ mcp.run(transport="stdio")
diff --git a/skyvern/cli/setup_commands.py b/skyvern/cli/setup_commands.py
new file mode 100644
index 000000000..a811bed2a
--- /dev/null
+++ b/skyvern/cli/setup_commands.py
@@ -0,0 +1,6 @@
+from .mcp import setup_mcp
+
+
+def setup_mcp_command() -> None:
+ """Wrapper command to configure the MCP server."""
+ setup_mcp()
diff --git a/skyvern/cli/tasks.py b/skyvern/cli/tasks.py
new file mode 100644
index 000000000..bda378b11
--- /dev/null
+++ b/skyvern/cli/tasks.py
@@ -0,0 +1,13 @@
+"""Task-related CLI helpers."""
+
+import typer
+
+from .console import console
+
+tasks_app = typer.Typer()
+
+
+@tasks_app.command()
+def placeholder() -> None:
+ """Placeholder command for task management."""
+ console.print("Task operations are not yet implemented.")
diff --git a/skyvern/cli/workflow.py b/skyvern/cli/workflow.py
new file mode 100644
index 000000000..892acaaae
--- /dev/null
+++ b/skyvern/cli/workflow.py
@@ -0,0 +1,13 @@
+"""Workflow-related CLI helpers."""
+
+import typer
+
+from .console import console
+
+workflow_app = typer.Typer()
+
+
+@workflow_app.command()
+def placeholder() -> None:
+ """Placeholder command for workflow operations."""
+ console.print("Workflow operations are not yet implemented.")