Skip to main content

CLI to resolve, compose, and install agent protocol packs for Cursor and similar targets.

Project description

Protocol Pack

CLI to resolve, compose, and stage agent protocol packs for Cursor (more targets later). Tool pointer: docs/protocol_pack_tool.md. Agent model (Rule-0): docs/agent_protocol_spec.md. Release polish: docs/polish_and_publish_plan.md.

Install

pipx install protocol-pack
# or, from a clone:
pip install -e ".[dev]"

Quickstart

protocol-pack init
# Optional: protocol-pack init --profile cursor.cursor_subtree
# Edit protocol-pack.toml [provides] globs, then:
protocol-pack build
protocol-pack doctor

Build output is written to .protocol-pack/build/ (adds .protocol-pack/ to .gitignore on init).

  • --merge-report path.json — JSON provenance (rules, protocols, packages).
  • --generate-router — emit protocol-pack-router.mdc (Rule-0 text for the active layout profile).
  • --merge-router — merge that router text into staged protocol-first-workflow.mdc when it exists (idempotent marker block).
  • --emit-provenance — prepend an HTML comment with package + source path on each emitted concrete protocol.
  • --no-validate-rules — skip .mdc frontmatter checks (legacy packs); by default rules must have valid Cursor frontmatter.
  • Tarball packagessource = { url = "https://.../pack.tgz" } (zip or tar.gz), optional sha256 and path (root inside archive).
  • install --link — symlink installed files to the staging tree (dev).

For pack authors

Drop-in README text for consumers: docs/pack_readme_authoring_snippet.md. Example CI workflow: docs/ci/github-actions.example.yml.

Status

Core CLI features described in the README are implemented (resolve, compose, Cursor emit, lockfile, tarball sources, router merge, provenance, skills, install --link). Further work is release/packaging and optional product hardening—see docs/polish_and_publish_plan.md.

Develop

Requires Python 3.11+. .github/workflows/ci.yml runs 3.11, 3.12, and 3.13 on every push and pull request.

python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
pytest -q
ruff check src tests && ruff format --check src tests
mypy src/protocol_pack

Changelog

Release notes: CHANGELOG.md.

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

protocol_pack-0.1.0.tar.gz (27.4 kB view details)

Uploaded Source

Built Distribution

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

protocol_pack-0.1.0-py3-none-any.whl (43.5 kB view details)

Uploaded Python 3

File details

Details for the file protocol_pack-0.1.0.tar.gz.

File metadata

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

File hashes

Hashes for protocol_pack-0.1.0.tar.gz
Algorithm Hash digest
SHA256 df31a840939d38e57e860acd47abe52b1413b78a5438fdf7bb68eb1377552c8f
MD5 99f00cfdb58f6fd85938f4205294f7e1
BLAKE2b-256 915f1cd257f5198f0fc3544a4e79207516ed669d0721d6eef357ef1e14fa5c3c

See more details on using hashes here.

Provenance

The following attestation bundles were made for protocol_pack-0.1.0.tar.gz:

Publisher: publish-pypi.yml on bursonic/ai-protocols

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

File details

Details for the file protocol_pack-0.1.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for protocol_pack-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c24e270633b403a0e2c975e874d4d7efc5e74f424c06dc35145dcf5b31d32c54
MD5 1028b1b4cdcc9b7da6e8cd5aa2b2707b
BLAKE2b-256 76d832a16e43b28eb785cd155c0e6b23826baeeb8daaf28f29e21c28620f206f

See more details on using hashes here.

Provenance

The following attestation bundles were made for protocol_pack-0.1.0-py3-none-any.whl:

Publisher: publish-pypi.yml on bursonic/ai-protocols

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