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

Integrations

Skillpacks is integrated with:

  • MLLM A prompt management, routing, and schema validation library for multimodal LLMs
  • Taskara A task management library for AI agents
  • Skillpacks A library to fine tune AI agents on tasks.
  • Threadmem A thread management library for AI agents

Community

Come join us on Slack

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"

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

  # Add the Poetry environment's bin directory to the PATH
  export PATH="$venv_dir/bin:$PATH"

  # Execute the surfkit.cli.main module using python -m
  surfkit "$@"
}

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.215.tar.gz (67.1 kB view details)

Uploaded Source

Built Distribution

surfkit-0.1.215-py3-none-any.whl (83.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: surfkit-0.1.215.tar.gz
  • Upload date:
  • Size: 67.1 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.215.tar.gz
Algorithm Hash digest
SHA256 9f93d6cbe5183083a937a8c260b901d73478d388d22f84c4c03e1883d6530374
MD5 866b2f16b2682370b0f6cbcf7415249c
BLAKE2b-256 c576b611532b02e20b8eb7ee66f9ff326d631949bf663e43f04ee1db44944f16

See more details on using hashes here.

File details

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

File metadata

  • Download URL: surfkit-0.1.215-py3-none-any.whl
  • Upload date:
  • Size: 83.3 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.215-py3-none-any.whl
Algorithm Hash digest
SHA256 d781c37948ec6f10d51a9cb0096297a9d34f6158c52c8b970a8730d306abb312
MD5 941881266888b4d940764b2cf0099dc6
BLAKE2b-256 00408406457aa818dcbd3850899a683d32f660c901bcae172eab60b9728c6080

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