vodorod/Dorod-Sky
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add dedicated quickstart doc (#2401)

Browse Source
This commit is contained in:
Shuchang Zheng
2025-05-20 12:48:38 -07:00
committed by GitHub
parent e87d0d4d40
commit e6f13c16e1
3 changed files with 64 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
fern/docs.yml
View File

@@ -61,6 +61,8 @@ navigation:
contents:
- page: Introduction
path: introduction.mdx
- page: Quickstart
path: getting-started/quickstart.mdx
- page: Skyvern In Action
path: getting-started/skyvern-in-action.mdx
- page: Task Prompting Guide

62
fern/getting-started/quickstart.mdx Normal file
View File

@@ -0,0 +1,62 @@
---
title: Quickstart
slug: getting-started/quickstart
---
## Quickstart
### Python SDK Installation
> ⚠️ **REQUIREMENT**: Skyvern runs with Python 3.11 ⚠️
```bash
pip install skyvern
```
### Run Task
#### Run Task On A Skyvern Service
Get your API key from [Skyvern Cloud](https://app.skyvern.com/settings). Send the task to Skyvern Cloud:
```python
from skyvern import Skyvern
skyvern = Skyvern(api_key="YOUR API KEY")
# OR pass the base_url to use any Skyvern service
# skyvern = Skyvern(base_url="http://localhost:8000", api_key="YOUR API KEY")
task = await skyvern.agent.run_task(prompt="Find the top post on hackernews today")
print(task)
```
More API & SDK information can be found in the [API Reference](/api-reference) section.
#### Run Task Locally
You can also run browser tasks locally in your python code but it takes a bit more effort to set up the environment:
1. **Configure Skyvern** Run the setup wizard which will guide you through the configuration process, including Skyvern [MCP](https://github.com/Skyvern-AI/skyvern/blob/main/integrations/mcp/README.md) integration. This will generate a `.env` as the configuration settings file.
```bash
skyvern init
```
2. **Run Task In Python Code**
```python
from skyvern import Skyvern
skyvern = Skyvern()
task = await skyvern.agent.run_task(prompt="Find the top post on hackernews today")
print(task)
```
<CardGroup cols={2}>
<Card
title="Quickstart (Skyvern Cloud)"
icon="cloud"
href="https://app.skyvern.com"
>
Start automating tasks with the hosted version of Skyvern
</Card>
<Card
title="Quickstart (Open Source)"
icon="github"
href="https://github.com/Skyvern-AI/Skyvern"
>
Start automating tasks in your own cloud
</Card>
</CardGroup>

59
fern/introduction.mdx
View File

@@ -68,62 +68,3 @@ Skyvern was inspired by the Task-Driven autonomous agent design popularized by [
Watch Skyvern navigate complex multi-page forms in any language
</Card>
</CardGroup>
## Quickstart
### Python SDK Installation
> ⚠️ **REQUIREMENT**: Skyvern runs with Python 3.11 ⚠️
```bash
pip install skyvern
```
### Run Task
#### Run Task On A Skyvern Service
Get your API key from [Skyvern Cloud](https://app.skyvern.com/settings). Send the task to Skyvern Cloud:
```python
from skyvern import Skyvern
skyvern = Skyvern(api_key="YOUR API KEY")
# OR pass the base_url to use any Skyvern service
# skyvern = Skyvern(base_url="http://localhost:8000", api_key="YOUR API KEY")
task = await skyvern.agent.run_task(prompt="Find the top post on hackernews today")
print(task)
```
More API & SDK information can be found in the [API Reference](/api-reference) section.
#### Run Task Locally
You can also run browser tasks locally in your python code but it takes a bit more effort to set up the environment:
1. **Configure Skyvern** Run the setup wizard which will guide you through the configuration process, including Skyvern [MCP](https://github.com/Skyvern-AI/skyvern/blob/main/integrations/mcp/README.md) integration. This will generate a `.env` as the configuration settings file.
```bash
skyvern init
```
2. **Run Task In Python Code**
```python
from skyvern import Skyvern
skyvern = Skyvern()
task = await skyvern.run_task(prompt="Find the top post on hackernews today")
print(task)
```
<CardGroup cols={2}>
<Card
title="Quickstart (Skyvern Cloud)"
icon="cloud"
href="https://app.skyvern.com"
>
Start automating tasks with the hosted version of Skyvern
</Card>
<Card
title="Quickstart (Open Source)"
icon="github"
href="https://github.com/Skyvern-AI/Skyvern"
>
Start automating tasks in your own cloud
</Card>
</CardGroup>