Skip to main content

ea-plugin-cli

Encre Agent Plugin Market Unified CLI

PyPI | Changelog

GitHub PyPI Python License

The single toolchain that takes a plugin from scaffold to the central registry. After publishing, the registry CI merges catalog entries into the ea-cwh index package, which the market backend renders locally.

🤖 What is ea-plugin-cli?

encre-plugin covers the full plugin lifecycle for the Encre Agent plugin market:

  • Scaffold — generate a ready-to-publish ea-plugin-<name> package skeleton
  • Build — enforce central-registry policy, compile a wheel, digest every artifact
  • Verify — smoke-test the wheel in an isolated venv (install, import, manifest probe)
  • Publish — upload to PyPI, then open the central-registry catalog PR automatically

Installation

Ready to run: python build.py cli compiles a single-file executable for the
current platform (build/cli/encre-plugin[.exe] — no pip install required; it
shells out to a host Python found on PATH for build/venv/twine and
auto-installs any missing components on first use)

Or as a module: pip install ea-plugin-cli   # development: pip install -e cli/

⭐ Commands

Command Purpose
encre-plugin init <name> Scaffold ea-plugin-<name> (pyproject + ea.plugins entry point + create_plugin factory + ui/src/index.ts + vendored plugin UI SDK)
encre-plugin build [pkg_dir] Compile ui/src/index.ts → ui/plugin.js, validate every ea-ui-* / RPC / slot against the SDK contract, run central-registry policy checks → python -m build (wheel + sdist) → sha256 per artifact → write dist/ea-build-info.json
encre-plugin sdk [--out dir] Materialise the distributable @encre/plugin-ui-sdk package (runtime, types, contract.json)
encre-plugin vendor Official batch build: walk core/ea_tools/* (accepts the ea-tool-/ea-skill- namespaces and the system-default tier), build + digest each package with the same policy, stage catalog.d/<name>.json and wheels into dist/vendor/ (staging only — no upload, no PR). Invoked by python build.py vendor
encre-plugin verify [pkg_dir] Install the wheel into a throwaway venv, import the entry-point factory and probe the manifest
encre-plugin publish [pkg_dir] twine upload to PyPI, then open a central-registry PR: the entry lands in the registry checkout's catalog.d/, git branch is cut from origin/main, committed, pushed, gh pr create
encre-plugin catalog regen Merge the registry's catalog.d/*.json → validate → write the ea-cwh catalog.json
encre-plugin catalog check <file> Validate a single catalog.json

📦 publish ↔ Central Registry

  • --registry-dir <dir> — use an existing registry checkout; when omitted, the CLI clones https://github.com/mf2023/ea-cwh.git into a local cache (%LOCALAPPDATA% / ~/.cache → encre-plugin-cli/registry) and hard-syncs it to origin/main every run
  • --registry-url <git url> — override the default remote (point at a fork or a local bare repository to rehearse the whole flow)
  • --no-upload — skip the twine upload, run the registry-PR half only
  • --dry-run — print the files that would be uploaded and the catalog entry; no remote action
  • The PR branch carries exactly one file (catalog.d/<name>.json): the branch is cut from origin/main before the entry is written, so no dirty worktree state can leak into the PR
  • Transition note: verify needs encre-harness to be importable inside the probe venv; for local development either pip install -e harness/ or use --no-deps plus a PYTHONPATH pointing at the source trees

🛡️ Central Registry Policy (enforced at build time)

# Rule
1 The PyPI distribution name must start with a reserved prefix — ea-plugin- (community) or ea-tool- / ea-skill- (vendor namespaces)
2 Must declare [project.entry-points."ea.plugins"]; one wheel carries exactly one plugin
3 Manifest name/version/description/author/license must be non-empty, manifest.version must match the pyproject version, and tier must be user (vendor builds may also ship system-default)
4 Must declare min_ea_version or engines["encre"]
5 Packages that declare UI (provides_ui / contributes.ui*) must ship it pre-compiled under ui/ and include it as package data — the install side never executes builds. encre-plugin build compiles ui/src/index.* and rejects unknown ea-ui-* classes, RPC methods and slot ids

🔧 Environment Variables

  • PyPI credentials: TWINE_USERNAME / TWINE_PASSWORD (CI uses trusted publishing and needs neither)
  • The automatic PR requires the registry checkout to have git remote add origin and a logged-in gh CLI

🌏 Community & License

📄 License

Apache License 2.0

This project uses the Apache License 2.0.

Metadata

Release files for ea-plugin-cli 0.20261025.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ea-plugin-cli 0.20261025.5
File Size Uploaded Provenance Actions
ea_plugin_cli-0.20261025.5.tar.gz 32.2 kB Without provenance Details for ea_plugin_cli-0.20261025.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ea-plugin-cli 0.20261025.5
File Interpreter ABI Platform Actions
ea_plugin_cli-0.20261025.5-py3-none-any.whl Python 3 none any Details for ea_plugin_cli-0.20261025.5-py3-none-any.whl

Total release size: 65.8 kB

Release files / ea_plugin_cli-0.20261025.5.tar.gz

Download URL ea_plugin_cli-0.20261025.5.tar.gz
Size 32.2 kB
Tags Source
SHA-256 checksum
How to use checksums
442d04904cc5e840b2f03d85ab5d3bda6f10821d681acbf8f35d17a580c46917
BLAKE2b-256 checksum
How to use checksums
88827af579b86a90d05902cfd72991232fda8559a8c235403337f6d937855d13
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / ea_plugin_cli-0.20261025.5-py3-none-any.whl

Download URL ea_plugin_cli-0.20261025.5-py3-none-any.whl
Size 33.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f856c4872e4aeed9789f3f2c7e26273cbd9cc59f95f79820b408f12c7561b522
BLAKE2b-256 checksum
How to use checksums
9d32e68e3b72af4ae3f37e5604f3e194d5210cc8bda1da187115903e8a3bf3aa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for ea-plugin-cli 0.20261025.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page