From e6f13c16e1e1162418147263dbe61e62c228db8f Mon Sep 17 00:00:00 2001 From: Shuchang Zheng Date: Tue, 20 May 2025 12:48:38 -0700 Subject: [PATCH] Add dedicated quickstart doc (#2401) --- fern/docs.yml | 2 + fern/getting-started/quickstart.mdx | 62 +++++++++++++++++++++++++++++ fern/introduction.mdx | 59 --------------------------- 3 files changed, 64 insertions(+), 59 deletions(-) create mode 100644 fern/getting-started/quickstart.mdx diff --git a/fern/docs.yml b/fern/docs.yml index 81a68c00..5d8ba19b 100644 --- a/fern/docs.yml +++ b/fern/docs.yml @@ -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 diff --git a/fern/getting-started/quickstart.mdx b/fern/getting-started/quickstart.mdx new file mode 100644 index 00000000..269803a6 --- /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) + ``` + + + + Start automating tasks with the hosted version of Skyvern + + + Start automating tasks in your own cloud + + diff --git a/fern/introduction.mdx b/fern/introduction.mdx index e6c63fc4..0f387d9d 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 - -## 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) -``` - - - - Start automating tasks with the hosted version of Skyvern - - - Start automating tasks in your own cloud - - -