Skip to main content

A CLI tool to browse, search, and run ACP agents

Project description

ACP Agent CLI & SDK ๐Ÿš€

PyPI version Python versions License: MIT

This project provides a friendly and intuitive CLI and SDK for the ACP Registry, enabling developers to quickly browse, search, run, and containerize ACP (Agent Client Protocol) agents.

Motivation ๐Ÿ’ก

The official ACP Registry provides an extensive list of agents. This project simplifies discovery and integration through three core pillars:

  • Interactive Discovery: Browse and fuzzy-search the entire registry directly from your terminal.
  • Seamless Execution: Run any agent locally with automatic environment setup, or integrate them into Python apps via the async SDK.
  • Production Deployment: Automatically generate optimized Containerfiles to run agents in isolated environments or CI/CD pipelines.

Usage ๐Ÿš€

There are three ways to use acp-agent:

1. CLI Usage

We recommend using uv to manage and run this project.

# List all agents
uvx acp-agent list

# Search for agents
uvx acp-agent search opencode

# Run an agent locally
uvx acp-agent run opencode

# Run with a specific working directory, environment variables, and extra arguments
# Any arguments after the options are passed directly to the agent
uvx acp-agent run opencode --cwd ./my-project -e DEBUG=true -- --help

Example Search Output

Search Results for 'opencode'
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ ID       โ”ƒ Name     โ”ƒ Description                  โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ opencode โ”‚ OpenCode โ”‚ The open source coding agent โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

2. SDK Usage

You can integrate acp-agent into your Python projects through ACPAgent.

import asyncio
from acp_agent import ACPAgent

async def main():
    agent = ACPAgent("opencode")

    # Run an agent and attach to its output (stdout/stderr)
    # This will automatically handle downloading and environment setup
    # returns the exit code of the agent
    exit_code = await agent.run(attach=True)
    print(f"Agent exited with code: {exit_code}")

if __name__ == "__main__":
    asyncio.run(main())

The same instance can also generate a Containerfile and provide config paths:

import asyncio
from pathlib import Path
from acp_agent import ACPAgent

async def main():
    agent = ACPAgent("opencode")

    # Generate Containerfile content for 'opencode'
    # This will inject the agent installation and CMD into your base image
    content = await agent.format_containerfile(containerfile="FROM python:3.12-slim")
    Path("Dockerfile").write_text(content)

    if config := agent.config:
        print(f"Config path: {config.config}")
        print(f"Credential path: {config.credential}")

if __name__ == "__main__":
    asyncio.run(main())

After starting your container, you can manually copy these files from your host to the container's expected locations (e.g., via docker cp) to fully replicate your host-side environment and authentication state within the isolated container.

License

MIT License

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

acp_agent-0.2.3.tar.gz (11.4 kB view details)

Uploaded Source

Built Distribution

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

acp_agent-0.2.3-py3-none-any.whl (16.9 kB view details)

Uploaded Python 3

File details

Details for the file acp_agent-0.2.3.tar.gz.

File metadata

  • Download URL: acp_agent-0.2.3.tar.gz
  • Upload date:
  • Size: 11.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for acp_agent-0.2.3.tar.gz
Algorithm Hash digest
SHA256 36daf2c5fd1eee9a0f0e319830462c7e87507a69bf2138b34090c556397ac096
MD5 d7daf25fec06d128e838d54fd7416736
BLAKE2b-256 7e81a15f3dae88a9a430c84c3a41d6103e2fcc337c01b509847500db01375eff

See more details on using hashes here.

Provenance

The following attestation bundles were made for acp_agent-0.2.3.tar.gz:

Publisher: release.yml on observerw/acp-agent

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file acp_agent-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: acp_agent-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 16.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for acp_agent-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 292d88308d12ce20cd15d9a94ea4adc1465c34fd1eb6497568ebe35736f73496
MD5 faf51e9d314ee9f32229acd13d67bd68
BLAKE2b-256 be980ae1e30659bcfd22ea86a504b8862530d5a155edfc7b76e6e1783fa6c026

See more details on using hashes here.

Provenance

The following attestation bundles were made for acp_agent-0.2.3-py3-none-any.whl:

Publisher: release.yml on observerw/acp-agent

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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