Skip to main content

A toolkit for building AI agents that use devices

Project description


Surfkit

A toolkit for building AI agents that use devices
Explore the docs »

View Demo · Report Bug · Request Feature


Installation

pip install surfkit

Usage

Building Agents

Initialize a new project

surfkit new [NAME]

Build a docker container for the agent

surfkit build

Running Agents

Create an agent locally

surfkit create agent --name foo

Create an agent on kubernetes

surfkit create agent --runtime kube

List running agents

surfkit list agents

Get details about a specific agent

surfkit get agent --name foo

Fetch logs for a specific agent

surfkit logs --name foo

Delete an agent

surfkit delete agent --name foo

Managing Devices

Create a device

surfkit create device --type desktop --provicer gce --name bar

List devices

surfkit list devices

View device in UI

surfkit view --name bar

Delete a device

surfkit delete device --name bar

Tracking Tasks

Create a tracker

surfkit create tracker

List trackers

surfkit list trackers

Delete a tracker

surfkit delete tracker -n foo

Solving Tasks

Solve a task with an existing setup

surfkit solve --description "search for common french ducks" --agent foo --device bar

Solve a task creating the agent ad hoc

surfkit solve --description "search for alpaca sweaters" \
--device bar --agent-file ./agent.yaml

Solve a task and kill the agent post-execution

surfkit solve --description "search for the meaning of life" \
--device bar --agent-file ./agent.yaml --kill

List tasks

surfkit list tasks

Publishing Agents

Login to the hub

surfkit login

Publish the agent

surfkit publish

List published agent types

surfkit list types

Run a published agent

surfkit create agent --type SurfPizza --runtime kube

Developing

Add the following function to your ~/.zshrc (or similar)

function sk() {
    local project_dir="/path/to/surfkit/repo"
    local venv_dir="$project_dir/.venv"

    local ssh_auth_sock="$SSH_AUTH_SOCK"
    local ssh_agent_pid="$SSH_AGENT_PID"

    source "$venv_dir/bin/activate"

    export SSH_AUTH_SOCK="$ssh_auth_sock"
    export SSH_AGENT_PID="$ssh_agent_pid"

    python -m surfkit.cli.main "$@"
    deactivate
}

Replacing /path/to/surfkit/repo with the absolute path to your local repo.

Then calling sk will execute the working code in your repo from any location.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

surfkit-0.1.192.tar.gz (60.0 kB view details)

Uploaded Source

Built Distribution

surfkit-0.1.192-py3-none-any.whl (75.4 kB view details)

Uploaded Python 3

File details

Details for the file surfkit-0.1.192.tar.gz.

File metadata

  • Download URL: surfkit-0.1.192.tar.gz
  • Upload date:
  • Size: 60.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.1 Darwin/22.6.0

File hashes

Hashes for surfkit-0.1.192.tar.gz
Algorithm Hash digest
SHA256 9231a277703c5b19e071bf57d8533d6e0d8f58737c3cd17fa40723209743055b
MD5 59ca15ce5cd8bfd59a00c19967ed53bc
BLAKE2b-256 ecd3becce16b283c3e08e9ac28f5771cefd9dca490fb54a002d7138368e61c84

See more details on using hashes here.

File details

Details for the file surfkit-0.1.192-py3-none-any.whl.

File metadata

  • Download URL: surfkit-0.1.192-py3-none-any.whl
  • Upload date:
  • Size: 75.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.1 Darwin/22.6.0

File hashes

Hashes for surfkit-0.1.192-py3-none-any.whl
Algorithm Hash digest
SHA256 11bdf4f523de2cdbde18e10ad90af123ebcd4723a17aa1710a30580bf125177a
MD5 21a75db43c0de69456e25c8460825c3d
BLAKE2b-256 f315b23496468be3270e48b5bad252e3ed404d9ce6ab53432a2224b9a061b608

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page