Quickstart

sudo add-apt-repository universe -y
sudo apt update
sudo apt install -y ansible

sudo add-apt-repository ppa:katakate.org/k7
sudo apt update
sudo apt install k7

k7 install --backend kfd,kql,k7d --k7d-version 0.2.1

k7 api status

k7 api endpoint

k7 generate-api-key mykey                 # unrestricted (all namespaces)
k7 generate-api-key tenant-a -n team-a    # scoped to one namespace (repeat -n)

k7 api disable        # scale k7-api to 0 (temporary off)
k7 api enable         # scale back to 1

name: demo
image: alpine:3.20
namespace: default
env_file: /root/secrets.env
limits:
  cpu: "100m"
  memory: "128Mi"
before_script: |
  # Installing curl. Egress open during before_script, then restricted (empty whitelist) afterwards
  apk add curl
  echo $ENV_VAR_1
egress_whitelist: []

# Uses k7.yaml in the current directory by default
k7 create

# Or pick a backend (kfd | kql | k7d)
k7 create -f k7.yaml --backend k7d

k7 shell demo

k7 list

k7 delete my-sandbox-123

k7 delete-all

# `k7 install` already deployed the API; just grab the endpoint and a key
k7 api endpoint
k7 generate-api-key my-key

pip install k7-sdk

from k7_sdk import Client

k7 = Client(endpoint="https://<your-endpoint>", api_key="<your-key>")

# Create sandbox
sb = k7.create({
    "name": "my-sandbox",
    "image": "alpine:latest"
})

# Execute code
result = sb.exec('echo "Hello World"')
print(result["stdout"])  # or just print(sb.exec("echo hi"))

# List and cleanup
print(k7.list())
sb.delete()

import asyncio
from k7_sdk import AsyncClient

async def main():
    k7 = AsyncClient(endpoint="https://<your-endpoint>", api_key="<your-key>")
    print(await k7.list())
    await k7.aclose()

asyncio.run(main())