Automate browser based workflows with AI
Python aiapiautomationbrowserbrowser-automationcomputergptllmplaywrightpowerautomatepuppeteerpythonrpaseleniumvisionworkflow
Add dedicated quickstart doc (#2401)
Shuchang Zhenge6f13c16e1e1
diff --git a/fern/docs.yml b/fern/docs.ymlindex 81a68c002..5d8ba19bf 100644--- a/fern/docs.yml+++ b/fern/docs.yml@@ -61,6 +61,8 @@ navigation:contents:- page: Introductionpath: introduction.mdx+ - page: Quickstart+ path: getting-started/quickstart.mdx- page: Skyvern In Actionpath: getting-started/skyvern-in-action.mdx- page: Task Prompting Guidediff --git a/fern/getting-started/quickstart.mdx b/fern/getting-started/quickstart.mdxnew file mode 100644index 000000000..269803a60--- /dev/null+++ b/fern/getting-started/quickstart.mdx@@ -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>diff --git a/fern/introduction.mdx b/fern/introduction.mdxindex e6c63fc4f..0f387d9d3 100644--- a/fern/introduction.mdx+++ b/fern/introduction.mdx@@ -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>-