Skip to main content

Python reference SDK for the Agent Command Line Interface Protocol

Project description

rendo-aclip

rendo-aclip is the canonical Python SDK for ACLIP, the Agent Command Line Interface Protocol.

It keeps normal CLI usage natural while standardizing the parts agents actually depend on:

  • progressive Markdown help
  • structured result and error envelopes
  • sidecar manifests for distribution metadata
  • packaging helpers for shipping runnable CLI artifacts

Install

Canonical package:

pip install rendo-aclip

Short-name official alias:

pip install aclip

Both install paths are first-party and synchronized. The import path is the same either way:

from aclip import AclipApp

If you want the canonical dependency name in project manifests, prefer rendo-aclip. If you want the shortest install command, aclip is the official alias.

Smallest End-to-End CLI

main.py

from aclip import AclipApp


def create_app() -> AclipApp:
    app = AclipApp(
        name="notes",
        version="0.2.1",
        summary="A minimal notes CLI.",
        description="Create and list notes from a small local CLI.",
    )

    def create_note(title: str, body: str) -> dict:
        """Create a note in a local JSON store.

        Args:
            title: Title for the note.
            body: Body text for the note.
        """
        return {"note": {"title": title, "body": body}}

    app.group(
        "note",
        summary="Manage notes",
        description="Create and inspect notes.",
    ).command(
        "create",
        handler=create_note,
        examples=["notes note create --title hello --body world"],
    )

    return app


app = create_app()

cli.py

from aclip import cli_main
from main import app


cli_main(app)

Run it like a normal CLI:

python cli.py --help
python cli.py note --help
python cli.py note create --help
python cli.py note create --title hello --body world

The final command emits a structured result envelope instead of ad hoc text.

Build A Distributable CLI

From a dedicated build script:

import aclip


artifact = aclip.build("main:app")

print(artifact.binary_path)
print(artifact.manifest_path)

"main:app" is the runtime import target the packaged binary will execute. That is why the recommended pattern is a separate build.py script instead of having the app object “build itself”.

If you prefer to keep initialization behind a function, ACLIP also supports an explicit factory target:

import aclip


artifact = aclip.build(factory="main:create_app")

Python also supports a shorthand when you already imported a top-level factory:

import aclip
from main import create_app


artifact = aclip.build(create_app)

In a conventional project layout, ACLIP infers:

  • project root
  • source root
  • executable name

src/ is optional. Advanced overrides such as project_root, source_root, and extra_paths are still available for monorepos or non-standard layouts, but they are no longer the default path.

What You Get

  • AclipApp for tree-shaped CLI authoring
  • direct handler=... registration and decorator authoring
  • cli_main(...) so launchers do not need manual sys.argv[1:]
  • build_cli() as the canonical packaging API

When To Use ACLIP

Use rendo-aclip when you want a CLI that still feels natural to command-line users while giving agents:

  • predictable help disclosure
  • predictable machine-readable command results
  • a stable packaging and distribution path

If your goal is only a human-first CLI with free-form text output, ACLIP is probably more structure than you need.

Repository

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

rendo_aclip-0.2.1.tar.gz (24.6 kB view details)

Uploaded Source

Built Distribution

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

rendo_aclip-0.2.1-py3-none-any.whl (21.1 kB view details)

Uploaded Python 3

File details

Details for the file rendo_aclip-0.2.1.tar.gz.

File metadata

  • Download URL: rendo_aclip-0.2.1.tar.gz
  • Upload date:
  • Size: 24.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for rendo_aclip-0.2.1.tar.gz
Algorithm Hash digest
SHA256 a88e1ce2b7b83ce111d5cc7bc366f5689e9dbe965d0d42e2911c7b9a7570e471
MD5 296621fca92a8714a6895e0a195ffeaa
BLAKE2b-256 89b5e3c1a3c703caa8fea281596d28c7ccba2d4c9fe5bf103e07489316a45b4c

See more details on using hashes here.

File details

Details for the file rendo_aclip-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: rendo_aclip-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 21.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for rendo_aclip-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 90c66640af03da88f1b4932c2fc650b27237e6add88207697fb75aa3ba774910
MD5 59facecd0d2509fa24d32b292b68e4e7
BLAKE2b-256 3859b18ebb0f2539cac3cd20f3286a2b90b4de9eed4deea4613c0c2e5b81f045

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