Repository files navigation

🐉 Automate Browser-based workflows using LLMs and Computer Vision 🐉

Skyvern automates browser-based workflows using LLMs and computer vision. It provides a simple API endpoint to fully automate manual workflows on a large number of websites, replacing brittle or unreliable automation solutions.

Traditional approaches to browser automations required writing custom scripts for websites, often relying on DOM parsing and XPath-based interactions which would break whenever the website layouts changed.

Instead of only relying on code-defined XPath interactions, Skyvern relies on Vision LLMs to learn and interact with the websites.

Skyvern was inspired by the Task-Driven autonomous agent design popularized byBabyAGI andAutoGPT -- with one major bonus: we give Skyvern the ability to interact with websites using browser automation libraries likePlaywright.

Skyvern uses a swarm of agents to comprehend a website, and plan and execute its actions:

This approach has a few advantages:

1. Skyvern can operate on websites it's never seen before, as it's able to map visual elements to actions necessary to complete a workflow, without any customized code
2. Skyvern is resistant to website layout changes, as there are no pre-determined XPaths or other selectors our system is looking for while trying to navigate
3. Skyvern is able to take a single workflow and apply it to a large number of websites, as it's able to reason through the interactions necessary to complete the workflow
4. Skyvern leverages LLMs to reason through interactions to ensure we can cover complex situations. Examples include:
   1. If you wanted to get an auto insurance quote from Geico, the answer to a common question "Were you eligible to drive at 18?" could be inferred from the driver receiving their license at age 16
   2. If you were doing competitor analysis, it's understanding that an Arnold Palmer 22 oz can at 7/11 is almost definitely the same product as a 23 oz can at Gopuff (even though the sizes are slightly different, which could be a rounding error!)

A detailed technical report can be foundhere.

Skyvern has SOTA performance on theWebBench benchmark with a 64.4% accuracy. The technical report + evaluation can be foundhere

Skyvern is the best performing agent on WRITE tasks (eg filling out forms, logging in, downloading files, etc), which is primarily used for RPA (Robotic Process Automation) adjacent tasks.

Skyvern Cloud is a managed cloud version of Skyvern that allows you to run Skyvern without worrying about the infrastructure. It allows you to run multiple Skyvern instances in parallel and comes bundled with anti-bot detection mechanisms, proxy network, and CAPTCHA solvers.

If you'd like to try it out, navigate toapp.skyvern.com and create an account.

Dependencies needed:

• Python 3.11.x, works with 3.12, not ready yet for 3.13
• NodeJS & NPM

Additionally, for Windows:

• Rust
• VS Code with C++ dev tools and Windows SDK

pip install skyvern

This is most helpful for first time run (db setup, db migrations etc).

skyvern quickstart

Start the Skyvern service and UI (when DB is up and running)

skyvern run all

Go tohttp://localhost:8080 and use the UI to run a task

fromskyvernimportSkyvernskyvern=Skyvern()task=awaitskyvern.run_task(prompt="Find the top post on hackernews today")print(task)

Skyvern starts running the task in a browser that pops up and closes it when the task is done. You will be able to view the task fromhttp://localhost:8080/history

You can also run a task on different targets:

fromskyvernimportSkyvern# Run on Skyvern Cloudskyvern=Skyvern(api_key="SKYVERN API KEY")# Local Skyvern serviceskyvern=Skyvern(base_url="http://localhost:8000",api_key="LOCAL SKYVERN API KEY")task=awaitskyvern.run_task(prompt="Find the top post on hackernews today")print(task)

⚠️ WARNING: SinceChrome 136, Chrome refuses any CDP connect to the browser using the default user_data_dir. In order to use your browser data, Skyvern copies your default user_data_dir to./tmp/user_data_dir the first time connecting to your local browser.⚠️

1. Just With Python Code

fromskyvernimportSkyvern# The path to your Chrome browser. This example path is for Mac.browser_path="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"skyvern=Skyvern(base_url="http://localhost:8000",api_key="YOUR_API_KEY",browser_path=browser_path,)task=awaitskyvern.run_task(prompt="Find the top post on hackernews today",)

2. With Skyvern Service

Add two variables to your .env file:

# The path to your Chrome browser. This example path is for Mac.CHROME_EXECUTABLE_PATH="/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"BROWSER_TYPE=cdp-connect

Restart Skyvern serviceskyvern run all and run the task through UI or code

Grab the cdp connection url and pass it to Skyvern

fromskyvernimportSkyvernskyvern=Skyvern(cdp_url="your cdp connection url")task=awaitskyvern.run_task(prompt="Find the top post on hackernews today",)

You can do this by adding thedata_extraction_schema parameter:

fromskyvernimportSkyvernskyvern=Skyvern()task=awaitskyvern.run_task(prompt="Find the top post on hackernews today",data_extraction_schema={"type":"object","properties": {"title": {"type":"string","description":"The title of the top post"            },"url": {"type":"string","description":"The URL of the top post"            },"points": {"type":"integer","description":"Number of points the post has received"            }        }    })

# Launch the Skyvern Server Separately*skyvern run server# Launch the Skyvern UIskyvern run ui# Check status of the Skyvern serviceskyvern status# Stop the Skyvern serviceskyvern stop all# Stop the Skyvern UIskyvern stop ui# Stop the Skyvern Server Separatelyskyvern stop server

1. Make sure you haveDocker Desktop installed and running on your machine
2. Make sure you don't have postgres running locally (Rundocker ps to check)
3. Clone the repository and navigate to the root directory
4. Runskyvern init llm to generate a.env file. This will be copied into the Docker image.
5. Fill in the LLM provider key on thedocker-compose.yml.If you want to run Skyvern on a remote server, make sure you set the correct server ip for the UI container indocker-compose.yml.
6. Run the following command via the commandline:

    docker compose up -d

7. Navigate tohttp://localhost:8080 in your browser to start using the UI

Important: Only one Postgres container can run on port 5432 at a time. If you switch from the CLI-managed Postgres to Docker Compose, you must first remove the original container:

docker rm -f postgresql-container

If you encounter any database related errors while using Docker to run Skyvern, check which Postgres container is running withdocker ps.

Tasks are the fundamental building block inside Skyvern. Each task is a single request to Skyvern, instructing it to navigate through a website and accomplish a specific goal.

Tasks require you to specify aurl,prompt, and can optionally include adata schema (if you want the output to conform to a specific schema) anderror codes (if you want Skyvern to stop running in specific situations).

Workflows are a way to chain multiple tasks together to form a cohesive unit of work.

For example, if you wanted to download all invoices newer than January 1st, you could create a workflow that first navigated to the invoices page, then filtered down to only show invoices newer than January 1st, extracted a list of all eligible invoices, and iterated through each invoice to download it.

Another example is if you wanted to automate purchasing products from an e-commerce store, you could create a workflow that first navigated to the desired product, then added it to a cart. Second, it would navigate to the cart and validate the cart state. Finally, it would go through the checkout process to purchase the items.

Supported workflow features include:

1. Browser Task
2. Browser Action
3. Data Extraction
4. Validation
5. For Loops
6. File parsing
7. Sending emails
8. Text Prompts
9. HTTP Request Block
10. Custom Code Block
11. Uploading files to block storage
12. (Coming soon) Conditionals

Skyvern allows you to livestream the viewport of the browser to your local machine so that you can see exactly what Skyvern is doing on the web. This is useful for debugging and understanding how Skyvern is interacting with a website, and intervening when necessary

Skyvern is natively capable of filling out form inputs on websites. Passing in information via thenavigation_goal will allow Skyvern to comprehend the information and fill out the form accordingly.

Skyvern is also capable of extracting data from a website.

You can also specify adata_extraction_schema directly within the main prompt to tell Skyvern exactly what data you'd like to extract from the website, in jsonc format. Skyvern's output will be structured in accordance to the supplied schema.

Skyvern is also capable of downloading files from a website. All downloaded files are automatically uploaded to block storage (if configured), and you can access them via the UI.

Skyvern supports a number of different authentication methods to make it easier to automate tasks behind a login. If you'd like to try it out, please reach out to usvia email ordiscord.

Skyvern supports a number of different 2FA methods to allow you to automate workflows that require 2FA.

Examples include:

1. QR-based 2FA (e.g. Google Authenticator, Authy)
2. Email based 2FA
3. SMS based 2FA

🔐 Learn more about 2FA supporthere.

Skyvern currently supports the following password manager integrations:

• Bitwarden
• 1Password
• LastPass

Skyvern supports the Model Context Protocol (MCP) to allow you to use any LLM that supports MCP.

See the MCP documentationhere

Skyvern supports Zapier, Make.com, and N8N to allow you to connect your Skyvern workflows to other apps.

• Zapier
• Make.com
• N8N

🔐 Learn more about 2FA supporthere.

We love to see how Skyvern is being used in the wild. Here are some examples of how Skyvern is being used to automate workflows in the real world. Please open PRs to add your own examples!

Book a demo to see it live

💡 See it in action

💡 See it in action

💡 See it in action

💡 See it in action

💡 See it in action

💡 See it in action

Make sure to haveuv installed.

1. Run this to create your virtual environment (.venv)

   uv sync --group dev

2. Perform initial server configuration

   uv run skyvern quickstart

3. Navigate tohttp://localhost:8080 in your browser to start using the UIThe Skyvern CLI supports Windows, WSL, macOS, and Linux environments.

More extensive documentation can be found on our📕 docs page. Please let us know if something is unclear or missing by opening an issue or reaching out to usvia email ordiscord.

RecommendedLLM_KEY:OPENAI_GPT4O,OPENAI_GPT4O_MINI,OPENAI_GPT4_1,OPENAI_O4_MINI,OPENAI_O3

RecommendedLLM_KEY:ANTHROPIC_CLAUDE3.5_SONNET,ANTHROPIC_CLAUDE3.7_SONNET,ANTHROPIC_CLAUDE4_OPUS,ANTHROPIC_CLAUDE4_SONNET

RecommendedLLM_KEY:AZURE_OPENAI

RecommendedLLM_KEY:BEDROCK_ANTHROPIC_CLAUDE3.7_SONNET_INFERENCE_PROFILE,BEDROCK_ANTHROPIC_CLAUDE4_OPUS_INFERENCE_PROFILE,BEDROCK_ANTHROPIC_CLAUDE4_SONNET_INFERENCE_PROFILE

RecommendedLLM_KEY:GEMINI_2.5_PRO_PREVIEW,GEMINI_2.5_FLASH_PREVIEW

RecommendedLLM_KEY:OLLAMA

Note: Ollama does not support vision yet.

RecommendedLLM_KEY:OPENROUTER

Supported LLM Key:OPENAI_COMPATIBLE

This is our planned roadmap for the next few months. If you have any suggestions or would like to see a feature added, please don't hesitate to reach out to usvia email ordiscord.

• Open Source - Open Source Skyvern's core codebase
• Workflow support - Allow support to chain multiple Skyvern calls together
• Improved context - Improve Skyvern's ability to understand content around interactable elements by introducing feeding relevant label context through the text prompt
• Cost Savings - Improve Skyvern's stability and reduce the cost of running Skyvern by optimizing the context tree passed into Skyvern
• Self-serve UI - Deprecate the Streamlit UI in favour of a React-based UI component that allows users to kick off new jobs in Skyvern
• Workflow UI Builder - Introduce a UI to allow users to build and analyze workflows visually
• Chrome Viewport streaming - Introduce a way to live-stream the Chrome viewport to the user's browser (as a part of the self-serve UI)
• Past Runs UI - Deprecate the Streamlit UI in favour of a React-based UI that allows you to visualize past runs and their results
• Auto workflow builder ("Observer") mode - Allow Skyvern to auto-generate workflows as it's navigating the web to make it easier to build new workflows
• Prompt Caching - Introduce a caching layer to the LLM calls to dramatically reduce the cost of running Skyvern (memorize past actions and repeat them!)
• Web Evaluation Dataset - Integrate Skyvern with public benchmark tests to track the quality of our models over time
• Improved Debug mode - Allow Skyvern to plan its actions and get "approval" before running them, allowing you to debug what it's doing and more easily iterate on the prompt
• Chrome Extension - Allow users to interact with Skyvern through a Chrome extension (incl voice mode, saving tasks, etc.)
• Skyvern Action Recorder - Allow Skyvern to watch a user complete a task and then automatically generate a workflow for it
• Interactable Livestream - Allow users to interact with the livestream in real-time to intervene when necessary (such as manually submitting sensitive forms)
• Integrate LLM Observability tools - Integrate LLM Observability tools to allow back-testing prompt changes with specific data sets + visualize the performance of Skyvern over time
• Langchain Integration - Create langchain integration in langchain_community to use Skyvern as a "tool".

We welcome PRs and suggestions! Don't hesitate to open a PR/issue or to reach out to usvia email ordiscord.Please have a look at ourcontribution guide and"Help Wanted" issues to get started!

If you want to chat with the skyvern repository to get a high level overview of how it is structured, how to build off it, and how to resolve usage questions, check outCode Sage.

By Default, Skyvern collects basic usage statistics to help us understand how Skyvern is being used. If you would like to opt-out of telemetry, please set theSKYVERN_TELEMETRY environment variable tofalse.

Skyvern's open source repository is supported via a managed cloud. All of the core logic powering Skyvern is available in this open source repository licensed under theAGPL-3.0 License, with the exception of anti-bot measures available in our managed cloud offering.

If you have any questions or concerns around licensing, pleasecontact us and we would be happy to help.