Quickstart
Start using agents in under 5 minutes
Overview
These are the basic steps to getting up and running:
- Install surfkit
- Create an agent instance
- Create a device
- Launch your agent to solve a task
Prerequisites
- Docker
- Python >= 3.10
- MacOS or Linux
If you are using Docker Desktop on MacOS, please update the settings: go to Settings | Advanced and make sure that the checkbox Allow the default Docker socket to be used (requires password) is checked. Save the settings, apply and restart.
Install Surfkit
pip install surfkit
Run an Agent
Find available agents on the Hub
surfkit find
Create a new agent
surfkit create agent -t mariyadavydova/SurfSlicer -n agent01
List running agents
surfkit list agents
Create a Device
Now that we’ve installed our agent, we need to give it a device to use.
The fastest way to get up and running is to install QEMU, but the most scalable is to create devices in GCP or AWS.
To create an Ubuntu desktop for our agent to use, select one of the following options ▼
List running devices
surfkit list devices
Create a Tracker
Before solving a task, we have the choice to create a tracker, which is a task server that tracks tasks for us in a Docker container.
surfkit create tracker -n tracker01 -r docker
Solve a task
Use the agent to solve a task on the device
surfkit solve "Search for the most common variety of french duck" \
--agent agent01 \
--device desktop01 \
--tracker tracker01
If you don’t create tracker explicitly before launching an agent, which you pass
to the solve command via the --tracker flag, surfkit will ask if you want
to create a tracker automatically.
What’s next
Now that you have a feel for the basics, you can move on to more advanced topics, like learning about all the tools in the surfkit or creating your own agent.