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

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)

Related Links

Feedback

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for ninoyi from gravatar.com ninoyi

Credits

PyPI data
Data sourced directly from PyPI's database.

Author: ninoyi

Requires

Python >=3.10

Provides Extra

dev

Tags

agent ai codebuddy sdk

Classifiers

Report project as malware

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

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

codebuddy_agent_sdk-0.3.243-py3-none-win_amd64.whl (52.2 MB view details)

Uploaded Python 3Windows x86-64

codebuddy_agent_sdk-0.3.243-py3-none-musllinux_1_1_x86_64.whl (47.4 MB view details)

Uploaded Python 3musllinux: musl 1.1+ x86-64

codebuddy_agent_sdk-0.3.243-py3-none-musllinux_1_1_aarch64.whl (47.3 MB view details)

Uploaded Python 3musllinux: musl 1.1+ ARM64

codebuddy_agent_sdk-0.3.243-py3-none-manylinux_2_17_x86_64.whl (49.0 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

codebuddy_agent_sdk-0.3.243-py3-none-manylinux_2_17_aarch64.whl (48.7 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ ARM64

codebuddy_agent_sdk-0.3.243-py3-none-macosx_11_0_arm64.whl (37.9 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

codebuddy_agent_sdk-0.3.243-py3-none-macosx_10_12_x86_64.whl (40.5 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file codebuddy_agent_sdk-0.3.243-py3-none-win_amd64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243-py3-none-win_amd64.whl
  • Upload date:
  • Size: 52.2 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.243-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 c0e268fe92b5f5cbc127ad52025cd3b639711bd3152a83a6b921cf2366b88ab8
MD5 503ecb84b9b74327a59c4b85688faca4
BLAKE2b-256 66028c9d880bb86cf99a990f9e181fbd3f082361372f3c8a458022534feb2f91

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.243-py3-none-musllinux_1_1_x86_64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243-py3-none-musllinux_1_1_x86_64.whl
  • Upload date:
  • Size: 47.4 MB
  • Tags: Python 3, musllinux: musl 1.1+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.243-py3-none-musllinux_1_1_x86_64.whl
Algorithm Hash digest
SHA256 d85de55b2f2d22d9010de7283726c294571da9ce40155a3192acc7bc1809aa1a
MD5 7f3c93968a7aa48d641560a185585f88
BLAKE2b-256 1c11a213827514c8dcb17cf130bd03af4cee54c28db31236d62c87a1f5a2e36d

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.243-py3-none-musllinux_1_1_aarch64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243-py3-none-musllinux_1_1_aarch64.whl
  • Upload date:
  • Size: 47.3 MB
  • Tags: Python 3, musllinux: musl 1.1+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.243-py3-none-musllinux_1_1_aarch64.whl
Algorithm Hash digest
SHA256 c62f68fc482ab1b9eeaa13fb3193b8132aa0498828fdfb3c90603f8729a6af36
MD5 17b14aca0823dcce7a17578a32eda72b
BLAKE2b-256 b930e05e87d339e52512b27df0b4b27da5e2ce6f5a2856b7d09bf26d55267282

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.243-py3-none-manylinux_2_17_x86_64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243-py3-none-manylinux_2_17_x86_64.whl
  • Upload date:
  • Size: 49.0 MB
  • Tags: Python 3, manylinux: glibc 2.17+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.243-py3-none-manylinux_2_17_x86_64.whl
Algorithm Hash digest
SHA256 869dc1082b61332c4b9eee6612ec41afc346fe3e0d47e4cc3c385e457991fd7d
MD5 141d10dd617c51d16f745ebfd1aa8f86
BLAKE2b-256 196536a6079a56610c3a36d04d143b7d8ae39ff0694bf67ae489bde65375a632

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.243-py3-none-manylinux_2_17_aarch64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243-py3-none-manylinux_2_17_aarch64.whl
  • Upload date:
  • Size: 48.7 MB
  • Tags: Python 3, manylinux: glibc 2.17+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.243-py3-none-manylinux_2_17_aarch64.whl
Algorithm Hash digest
SHA256 556bcb37fe83a760e92508c505d7f71da3a489aa4bf3352db522adbb29fdb180
MD5 1e9a28405e825c85b221f80464ae5313
BLAKE2b-256 269f6f4d0f4991fabdbc083cf6d6b60ab230717e0cbf8cea17fc21ef9b3e9fe0

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.243-py3-none-macosx_11_0_arm64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243-py3-none-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 37.9 MB
  • Tags: Python 3, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.243-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 58aaac5137c69d312156f51092d2e0d34d501639b77896eae374a4777948f7a8
MD5 c57db4f633259d322b044e848701f0e2
BLAKE2b-256 9fc0cd59b73da88c2ad5b9a6e1599fbe2512bc78a0ad74589a19d14b0e74b7be

See more details on using hashes here.

File details

Details for the file codebuddy_agent_sdk-0.3.243-py3-none-macosx_10_12_x86_64.whl.

File metadata

  • Download URL: codebuddy_agent_sdk-0.3.243-py3-none-macosx_10_12_x86_64.whl
  • Upload date:
  • Size: 40.5 MB
  • Tags: Python 3, macOS 10.12+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.12 {"installer":{"name":"uv","version":"0.11.12","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}

File hashes

Hashes for codebuddy_agent_sdk-0.3.243-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 ba78b87a8b962b0f03e733045f9ebd7358c5ef82e37ee048797f6c58977ee294
MD5 a778bbe7f701551e6b4a7299f2ed90d6
BLAKE2b-256 2bc9e84cc80a404aaa1296d7ef4372a904fa2402840a8d698a1ab72545eaea38

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.3.243 This release

7 files

Pre-release

0.3.243.dev202608232305

7 files

0.3.236

7 files

0.3.227

7 files

0.3.221

7 files

0.3.219

7 files

0.3.215

7 files

0.3.205

7 files

0.3.202

7 files

0.3.195

7 files

0.3.189

7 files

0.3.187

7 files

0.3.178

7 files

0.3.176

7 files

0.3.174

7 files

0.3.168

7 files

0.3.167

7 files

0.3.162

7 files

0.3.160

7 files

0.3.149

7 files

0.3.134

7 files

0.3.119

7 files

0.3.109

7 files

0.3.99

7 files

0.3.89

7 files

0.2.3

7 files

Yanked

0.1.19

4 files

Yanked

0.1.18

4 files

Yanked

0.1.17

4 files

Yanked

0.1.16

4 files

Yanked

0.1.15

4 files

0.0.1

2 files

Supported by

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