Quickstart

uv add raysurfer

bun add raysurfer

# Before
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

async with ClaudeSDKClient(options) as client:
    await client.query("Generate quarterly report")
    async for msg in client.receive_response():
        print(msg)

# After
from raysurfer import RaysurferClient
from claude_agent_sdk import ClaudeAgentOptions  # Options come from Claude SDK

async with RaysurferClient(options) as client:
    await client.query("Generate quarterly report")
    async for msg in client.response():
        print(msg)

// Before
import { ClaudeSDKClient } from "@anthropic-ai/claude-agent-sdk";

const client = new ClaudeSDKClient(options);
for await (const msg of client.query("Generate quarterly report")) {
  console.log(msg);
}

// After
import { RaysurferClient } from "raysurfer";

const client = new RaysurferClient(options);
for await (const msg of client.query("Generate quarterly report")) {
  console.log(msg);
}

from raysurfer import AsyncRaySurfer

rs = AsyncRaySurfer(api_key="your_api_key")

@rs.tool
def add(a: int, b: int) -> int:
    """Add two numbers together."""
    return a + b

user_code = "result = add(5, 3)\nprint(result)"
result = await rs.execute(
    "Use add to compute 5 + 3, then print the result",
    user_code=user_code,
)
print(result.result)     # "8"
print(result.cache_hit)  # False (reserved field)

import { RaySurfer } from "raysurfer";

const rs = new RaySurfer({ apiKey: "your_api_key" });

rs.tool("add", "Add two numbers", { a: "integer", b: "integer" },
  async (args) => String(Number(args.a) + Number(args.b))
);

const userCode = `
result = add(5, 3)
print(result)
`;
const result = await rs.execute("Use add to compute 5 + 3, then print the result", {
  userCode,
});
console.log(result.result);    // "8"
console.log(result.cacheHit);  // false (reserved field)