Skip to main content

Shared chassis for agent-ready CLIs: the exit-code contract, JSON/table/markdown/CSV output with field projection, and keyring-backed credentials.

Project description

agent-tool-shared-cli

The shared chassis for the agent-tool-<x>-cli family — agent-ready command-line tools that an LLM can drive with no prior knowledge of them.

Consumers: agent-tool-openproject-cli, agent-tool-drone-cli (in progress).

This repo also holds BLUEPRINT.md — the engineering standard the whole family is built to. Read that first if you are standing up a new tool.

pip install agent-tool-shared-cli

What's in it

This package is deliberately small. It holds the agent contract and the pure utilities that implement it — the things that must be identical across every tool, because an agent learns the contract once and applies it everywhere.

Module What
agentcli.errors The exit-code taxonomy (0/1/3/4/5/6/7/130) + DryRun
agentcli.output Emitter: json/table/markdown/csv, --fields projection, NDJSON streaming
agentcli.credentials Keyring storage with a 0600 fallback and an env override
agentcli.appspec AppSpec — the two strings that make all of the above tool-specific
from agentcli import AppSpec, Credentials, Emitter, OutputFormat, NotFoundError

SPEC = AppSpec(name="drone-cli", env_prefix="DRONECLI")

SPEC.config_dir()            # ~/.config/drone-cli  (or $DRONECLI_CONFIG_DIR)
SPEC.env("TOKEN")            # "DRONECLI_TOKEN"

Credentials(SPEC).get_token("default")     # env > keyring > 0600 file
Emitter(OutputFormat.json, fields=["id", "status"]).emit(rows)
raise NotFoundError("no such build")       # -> exit 5, JSON on stderr

The exit-code contract

Published API. You may leave a code unallocated, or repurpose one deliberately. You may never renumber one — agents branch on these, and they are documented in three places per tool (README, the in-binary guide, and the Claude skill).

Code Meaning
0 success (including a successful --dry-run)
1 generic error
2 reserved for Click/Typer usage errors — never allocate
3 config error
4 auth error (401/403)
5 not found (404)
6 conflict (409 / optimistic locking)
7 validation error (422) — see fieldErrors
8+ per-tool, and only for a condition you have observed
130 SIGINT

What is deliberately NOT here

client.py, serialize.py, resolve.py and the domain commands stay in each tool. They look shareable and are not:

OpenProject stops paginating on an authoritative total — "never stop on a short page". Drone has no total, and a short page is the terminator. The rule that inverts between tool #1 and tool #2 is exactly the rule you must not hoist.

Auth schemes, retry matrices and error-body shapes are the same story. Pulling them in would make this a framework with a config object per tool, which is how shared-code projects die.

Share the contract, not the transport.

Contributing

You need nothing but Python:

pip install -e '.[test]'
pytest                       # 74 tests, no network, no services

Changes here affect every downstream CLI. Two rules:

  1. Never renumber an exit code, and never change an output shape without treating it as a breaking change — downstream agents depend on both.
  2. Don't add a module because two tools happen to share it today. Wait until a third does, and until you can state the rule it obeys. tests/test_contract.py is the tripwire: if a change makes you edit it, stop and think.

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

agent_tool_shared_cli-0.1.2.tar.gz (18.7 kB view details)

Uploaded Source

Built Distribution

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

agent_tool_shared_cli-0.1.2-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file agent_tool_shared_cli-0.1.2.tar.gz.

File metadata

  • Download URL: agent_tool_shared_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 18.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for agent_tool_shared_cli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 3cf0011c012d0bb1f8000d43e430e193352539326da92ad99ee365f682486f2b
MD5 6ad335cf58a0fff803c3e61472367ced
BLAKE2b-256 845b2bc15ceb09fa19c07c4b275b0ff6dcd57e95d006cbe8bb94a437380aaf5e

See more details on using hashes here.

Provenance

The following attestation bundles were made for agent_tool_shared_cli-0.1.2.tar.gz:

Publisher: release.yml on alexander-zierhut/agent-tool-shared-cli

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

File details

Details for the file agent_tool_shared_cli-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for agent_tool_shared_cli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a7ab9bd9642f068069269dc2c48ccd790d3937135a250681e1be60022a924ebc
MD5 898d17328980daa5b02526ec3ec53027
BLAKE2b-256 5d780bece90bf73024dca8c39850f4f1f390a44d5806efec8c3767e7035da67a

See more details on using hashes here.

Provenance

The following attestation bundles were made for agent_tool_shared_cli-0.1.2-py3-none-any.whl:

Publisher: release.yml on alexander-zierhut/agent-tool-shared-cli

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