Skip to main content

Drop-in replacement for Claude Agent SDK with automatic code caching - just swap your import

Project description

RaySurfer Python SDK

Drop-in replacement for Claude Agent SDK with automatic code caching.

Installation

pip install raysurfer

Setup

Set your API key:

export RAYSURFER_API_KEY=your_api_key_here

Get your key from the dashboard.

Usage

Swap your client class and method names. Options come directly from claude_agent_sdk:

# Before
from claude_agent_sdk import ClaudeSDKClient, ClaudeAgentOptions

# After
from raysurfer import RaysurferClient
from claude_agent_sdk import ClaudeAgentOptions

options = ClaudeAgentOptions(
    allowed_tools=["Read", "Write", "Bash"],
    system_prompt="You are a helpful assistant.",
)

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

Method Mapping

Claude SDK Raysurfer
ClaudeSDKClient(options) RaysurferClient(options)
await client.query(prompt) await client.raysurfer_query(prompt)
client.receive_response() client.raysurfer_response()

How It Works

  1. On raysurfer_query(): Retrieves cached code blocks matching your task
  2. Downloads to sandbox: Files ready for the agent to execute
  3. Injects into prompt: Agent sees proven code snippets
  4. After success: New code is cached for next time

Caching is enabled automatically when RAYSURFER_API_KEY is set.

Snippet Retrieval Scope

Control which cached snippets are retrieved using public_snips and snips_desired:

from raysurfer import RaysurferClient
from claude_agent_sdk import ClaudeAgentOptions

options = ClaudeAgentOptions(
    allowed_tools=["Read", "Write", "Bash"],
)

# Include both public and company snippets
client = RaysurferClient(
    options,
    public_snips=True,        # Include public/shared snippets
    snips_desired="company",  # Also include company-level snippets
)

# Enterprise: Retrieve client-specific snippets only
client = RaysurferClient(
    options,
    snips_desired="client",   # Client workspace snippets (Enterprise only)
)
Configuration Required Tier
public_snips=True only FREE (default)
snips_desired="company" TEAM or ENTERPRISE
snips_desired="client" ENTERPRISE only

Full Example

import asyncio
import os
from raysurfer import RaysurferClient
from claude_agent_sdk import ClaudeAgentOptions

os.environ["RAYSURFER_API_KEY"] = "your_api_key"

async def main():
    options = ClaudeAgentOptions(
        allowed_tools=["Read", "Write", "Bash"],
        system_prompt="You are a helpful assistant.",
    )

    async with RaysurferClient(options) as client:
        # First run: generates and caches code
        await client.raysurfer_query("Fetch GitHub trending repos")
        async for msg in client.raysurfer_response():
            print(msg)

        # Second run: retrieves from cache (instant)
        await client.raysurfer_query("Fetch GitHub trending repos")
        async for msg in client.raysurfer_response():
            print(msg)

asyncio.run(main())

Without Caching

If RAYSURFER_API_KEY is not set, RaysurferClient behaves exactly like ClaudeSDKClient — no caching, just a pass-through wrapper.

Low-Level API

For custom integrations, use the RaySurfer client directly with three core methods:

from raysurfer import RaySurfer

client = RaySurfer(api_key="your_api_key")

# 1. Get cached code snippets for a task
snips = client.get_code_snips(task="Fetch GitHub trending repos")
for match in snips.code_blocks:
    print(f"{match.code_block.name}: {match.score}")

# Or use the unified search endpoint
search_result = client.search(task="Fetch GitHub trending repos")
for match in search_result.matches:
    print(f"{match.code_block.name}: {match.combined_score}")

# 2. Upload new code snippets after execution
from raysurfer.types import FileWritten, LogFile

files = [FileWritten(filename="fetch_repos.py", content="def fetch(): ...")]
client.upload_new_code_snips(
    task="Fetch GitHub trending repos",
    files_written=files,
    succeeded=True,
)

# 2b. Bulk upload prompts/logs/code for sandboxed grading
logs = [LogFile(path="logs/run.log", content="Task completed", encoding="utf-8")]
client.upload_bulk_code_snips(
    prompts=["Build a CLI tool", "Add CSV support"],
    files_written=[FileWritten(path="cli.py", content="def main(): ...")],
    log_files=logs,
    auto_vote=True,
)

# 3. Vote on whether a cached snippet was useful
client.vote_code_snip(
    task="Fetch GitHub trending repos",
    code_block_id="abc123",
    code_block_name="github_fetcher",
    code_block_description="Fetches trending repos from GitHub",
    succeeded=True,
)

Async Version

from raysurfer import AsyncRaySurfer

async with AsyncRaySurfer(api_key="your_api_key") as client:
    snips = await client.get_code_snips(task="Fetch GitHub trending repos")
    await client.upload_new_code_snips(task, files, succeeded=True)
    await client.vote_code_snip(task, code_block_id, name, description, succeeded=True)

Method Reference

Method Description
get_code_snips(task, top_k, min_verdict_score) Retrieve cached code snippets by semantic search
upload_new_code_snips(task, files_written, succeeded) Store new code files for future reuse
upload_bulk_code_snips(prompts, files_written, log_files, auto_vote) Bulk upload prompts/logs/code for sandboxed grading
vote_code_snip(task, code_block_id, name, description, succeeded) Vote on snippet usefulness

License

MIT

Project details


Download files

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

Source Distribution

raysurfer-0.6.5.tar.gz (4.7 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

raysurfer-0.6.5-py3-none-any.whl (20.0 kB view details)

Uploaded Python 3

File details

Details for the file raysurfer-0.6.5.tar.gz.

File metadata

  • Download URL: raysurfer-0.6.5.tar.gz
  • Upload date:
  • Size: 4.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for raysurfer-0.6.5.tar.gz
Algorithm Hash digest
SHA256 01193913e0820d739adce87e37c1ba523611cc059298dc7b105bbb3b40b451f5
MD5 36974ac24eab5cd58b756c25e98b4b46
BLAKE2b-256 8c58600a087872320348357e467043753e82d485c89a6d7dfffe717c4a615db9

See more details on using hashes here.

File details

Details for the file raysurfer-0.6.5-py3-none-any.whl.

File metadata

  • Download URL: raysurfer-0.6.5-py3-none-any.whl
  • Upload date:
  • Size: 20.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for raysurfer-0.6.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f9d29916b7cf64bf0ef64a243d3bf68fb866dcc2233b45563423320a6d8edce0
MD5 5dfabc8ac02d91bfbef522d3411ce1c8
BLAKE2b-256 36bd724ba6728636ff513b927e5dd16a235294508d8917563dcbe348448cda45

See more details on using hashes here.

Supported by

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