Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

CodeBuddy Agent SDK for Python

SDK for building AI agents with CodeBuddy Code's capabilities. Programmatically interact with AI to build autonomous agents that can understand codebases, edit files, and execute workflows.

Installation

# Using uv (recommended)
uv add codebuddy-agent-sdk

# Using pip
pip install codebuddy-agent-sdk

Quick Start

import asyncio
from codebuddy_agent_sdk import query

async def main():
    async for message in query(
        prompt="What files are in this directory?",
        permission_mode="bypassPermissions",
    ):
        if message.type == "assistant":
            for block in message.content:
                if hasattr(block, "text"):
                    print(block.text)

asyncio.run(main())

API Reference

query(prompt, **options)

Create a query to interact with the agent.

async for message in query(
    prompt="Your prompt here",
    model="sonnet",                    # Model to use
    permission_mode="bypassPermissions",  # Permission mode
    max_turns=10,                      # Maximum conversation turns
    cwd="/path/to/project",            # Working directory
):
    # Handle message
    pass

Model listing

CodeBuddySDKClient can fetch the model catalog from the CLI:

from codebuddy_agent_sdk import CodeBuddySDKClient, CodeBuddyAgentOptions

async def main():
    async with CodeBuddySDKClient(options=CodeBuddyAgentOptions()) as client:
        # Live catalog (one control request each):
        models = await client.get_available_models()    # [{model_id, name, description}]
        raw = await client.get_available_models_raw()   # full configs (url/apiKey stripped)

        # Snapshot captured during the initialize handshake:
        snapshot = await client.supported_models()      # [ModelInfo(value, display_name, description)]

get_available_models() / get_available_models_raw() work right after connect(); supported_models() is a read-only metadata read (a bare initialize control request) that never touches the session handshake.

Message Types

  • system - Session initialization info
  • assistant - Agent responses (text, tool calls)
  • result - Query completion status
  • task_started / task_notification - Background task lifecycle events (TaskStartedMessage / TaskNotificationMessage, both subclasses of SystemMessage). Emitted when a tool runs a command with run_in_background: true. Concurrent tasks are told apart by task_id.

Background tasks

Background task completion can arrive after the first ResultMessage, so use CodeBuddySDKClient with receive_messages() (which keeps reading) rather than query() / receive_response() (which stop at the first result):

from codebuddy_agent_sdk import (
    CodeBuddySDKClient,
    CodeBuddyAgentOptions,
    TaskStartedMessage,
    TaskNotificationMessage,
)

async def main():
    options = CodeBuddyAgentOptions(permission_mode="bypassPermissions")
    async with CodeBuddySDKClient(options=options) as client:
        await client.query("Run a background command and report when it finishes")
        async for msg in client.receive_messages():
            if isinstance(msg, TaskStartedMessage):
                print("started", msg.task_id, msg.description)
            elif isinstance(msg, TaskNotificationMessage):
                print("done", msg.task_id, msg.status, msg.output_file)

Feedback

Metadata

Release files for codebuddy-agent-sdk 0.3.304.dev202611181914

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for codebuddy-agent-sdk 0.3.304.dev202611181914
File Actions
codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details for codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-win_amd64.whl
codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-musllinux_1_1_x86_64.whl Python 3 none Linux musl 1.1+ x86-64 Details for codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-musllinux_1_1_x86_64.whl
codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-musllinux_1_1_aarch64.whl Python 3 none Linux musl 1.1+ ARM64 Details for codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-musllinux_1_1_aarch64.whl
codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-manylinux_2_17_x86_64.whl Python 3 none Linux glibc 2.17+ x86-64 Details for codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-manylinux_2_17_x86_64.whl
codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-manylinux_2_17_aarch64.whl Python 3 none Linux glibc 2.17+ ARM64 Details for codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-manylinux_2_17_aarch64.whl
codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details for codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-macosx_11_0_arm64.whl
codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-macosx_10_12_x86_64.whl Python 3 none macOS 10.12+ x86-64 Details for codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-macosx_10_12_x86_64.whl

Total release size: 475.1 MB

Release files / codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-win_amd64.whl

Download URL codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-win_amd64.whl
Size 74.8 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
f477e75a56da0da39c2e950f2ccfd041ff00d32bf0e95509e17ea251e15ee576
BLAKE2b-256 checksum
How to use checksums
67a7ebdf07f6bf1533c38a36a90ab3c4cd5f2fadac7d587ebb5f827ea76d591f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-musllinux_1_1_x86_64.whl

Download URL codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-musllinux_1_1_x86_64.whl
Size 67.3 MB
Tags Linux musl 1.1+ x86-64 Python 3
SHA-256 checksum
How to use checksums
da219fef6a21ceb97688edebdfdf6931ab1582652bdafe082336345d4e3db21b
BLAKE2b-256 checksum
How to use checksums
ee2205e818736bc2b39c53f46b51c3a8de3d9fb8094ead859e190467178bc9fa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-musllinux_1_1_aarch64.whl

Download URL codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-musllinux_1_1_aarch64.whl
Size 66.9 MB
Tags Linux musl 1.1+ ARM64 Python 3
SHA-256 checksum
How to use checksums
3ff3a0e42e2a0c1301f4e1de3c00c4ecdf02ca3ccbe781364f3c065012026dcd
BLAKE2b-256 checksum
How to use checksums
7dcbe96b68cbb5206344a8a337c74d6975995d609d11ffbb3e153ed7e4412b33
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-manylinux_2_17_x86_64.whl

Download URL codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-manylinux_2_17_x86_64.whl
Size 70.9 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
51de3f212f06e2e3061b7e438e95bfaa5b9f73da5f4c47443933c1742a92b89a
BLAKE2b-256 checksum
How to use checksums
defe46eebefaadab386e79721ba2b5cf29834d38f177d60808fc83b2237b2a3e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-manylinux_2_17_aarch64.whl

Download URL codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-manylinux_2_17_aarch64.whl
Size 70.7 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
9eddbd986cbded1fbb55995cac0d700042869d378198c823cea364fc6279f3a5
BLAKE2b-256 checksum
How to use checksums
813cc529bbe4eec557600d7715c9636caa6edb742e22380821ac3490f9855c78
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-macosx_11_0_arm64.whl

Download URL codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-macosx_11_0_arm64.whl
Size 61.0 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
e66cfdd0a3dce7ed4134013a6c0272d9be9a827699f982bf9855a370f7fbe99b
BLAKE2b-256 checksum
How to use checksums
7cdf7a4cd212ae8180d9b8847860c61377473a66471dc86dd9b963bc0d906cca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-macosx_10_12_x86_64.whl

Download URL codebuddy_agent_sdk-0.3.304.dev202611181914-py3-none-macosx_10_12_x86_64.whl
Size 63.6 MB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
fd522fdd87b3b8b2ba7d23475eca33e1c425b87ab88122be57496af024f1bb22
BLAKE2b-256 checksum
How to use checksums
f7d04ae593b282c6124e89e0f564ad344bd346c8055527f12bf309c176cd1abc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.13.5 {"installer":{"name":"uv","version":"0.13.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"12","id":"bookworm","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for codebuddy-agent-sdk 0.3.304.dev202611181914

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page