ivo.zilkenat
  • Joined on 2025-10-29

convex-project-cli (0.1.2)

Published 2026-06-12 12:02:12 +00:00 by ivo.zilkenat

Installation

pip install --index-url  --extra-index-url https://pypi.org/ convex-project-cli

About this package

Generic CLI framework for a Convex deployment — branded config, spec-driven discovery, and the config/functions/describe/call commands.

convex-project-cli

Generic CLI framework for driving a Convex deployment's public API as a real user. Supplies the reusable machinery a branded CLI needs:

  • AppBranding — the data that names a CLI: display name, config filename, YAML top-key, env-var prefix, JWT-cache filename.
  • Multi-env YAML config loading, parameterized by branding → a convex_rpc.Config.
  • On-disk JWT cache (FileTokenCache) implementing the convex_rpc.TokenCache hook.
  • Output formatting (at-core OutputFormatter, table / --json).
  • Generic commandsconfig, functions, describe, call — spec-driven discovery + the call escape hatch, reading a bundled spec.json the host app supplies.
  • ConvexCliApp — the extension API a host CLI (e.g. plexus-cli) builds on: pass branding, a spec loader, and host-specific commands; it assembles the argparse skeleton + dispatch.

A host app specializes this with its own branding, its own subcommands, and its own bundled spec. Run standalone (convex-project) with just a spec + a branded YAML config.

Requirements

Requires Python: >=3.12
Details
PyPI
2026-06-12 12:02:12 +00:00
0
31 KiB
Assets (2)
Versions (5) View all
0.1.4 2026-06-12
0.1.3 2026-06-12
0.1.2 2026-06-12
0.1.1 2026-06-11
0.1.0 2026-06-11