Skip to main content

XGIC CLI Payload CMS module - product commands and helpers (xgic.cli.payload).

Project description

XGIC Payload CMS CLI

License

XGIC Payload CMS CLI (xgic.cli.payload) provides Payload CMS–specific helpers and xgic payload … subcommands for the modular XGIC CLI.

Architecture: ADR-0005.

Publishing to PyPI: python-package-release.md
(publish after xgic-cli and xgic-dev-cli for stack releases). Tags: vX.Y.ZrcN → TestPyPI; vX.Y.Z → PyPI.

Package Role
xgic/cli Thin core framework (xgic)
xgic/dev-cli Dev Container / Compose + generic lifecycle
This repo Payload CMS product module (xgic.cli.payload)

Status

0.2.0 — B4 product commands. Library helpers + nested xgic payload command group. Transitional in-tree xde may still ship until hard cutover (B5).

Requirements

  • Python 3.14+
  • xgic-cli ≥ 0.2.0
  • xgic-dev-cli ≥ 0.2.0

Install (development)

python -m pip install -e ../cli
python -m pip install -e ../dev-cli
python -m pip install -e ".[dev]"
xgic payload --help

Console commands

All product commands are nested under xgic payload (domain ownership; no clash with generic lifecycle).

Command Purpose
xgic payload dev Smart start: compose up if needed, DB check, pnpm dev
xgic payload setup [--quiet] Ensure Payload CMS project directory
xgic payload env [--json] Product env status (project name, .env, services)
xgic payload env --regenerate --yes Fresh credentials in .devcontainer/.env
xgic payload schema Run template schema generator when present
xgic payload reset Fast targeted reset (project folder + DB volume)

Note: Generic lifecycle (xgic up / down / check / env) lives in dev-cli.
Use xgic payload env for Payload CMS credentials and product status.

Command map (transitional xde → XGIC CLI)

Today (xde) Target
xde dev xgic payload dev
xde setup payloadcms xgic payload setup
xde schema xgic payload schema
xde env --regenerate xgic payload env --regenerate --yes
xde reset xgic payload reset
xde up / down / … xgic up / down / … (dev-cli)

Library API

from xgic.cli.payload import (
    ensure_payload_project,
    generate_fresh_env_content,
    make_payload_docker_controller,
    get_payload_project_name,
)

License

Apache License 2.0. See LICENSE and NOTICE.
Copyright form: Copyright 2026 XGIC.

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

xgic_payload_cms_cli-0.2.0.tar.gz (14.0 kB view details)

Uploaded Source

Built Distribution

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

xgic_payload_cms_cli-0.2.0-py3-none-any.whl (19.4 kB view details)

Uploaded Python 3

File details

Details for the file xgic_payload_cms_cli-0.2.0.tar.gz.

File metadata

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

File hashes

Hashes for xgic_payload_cms_cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f39a2bc7aef4b8ff98e8f8bb4713aa1159f35ab235fd12991915b4d152217033
MD5 583c56f2fc4f44ce4d6da3daf9374f26
BLAKE2b-256 64e6c827a6c4e179d5537cee779317f0f32744b04a84785f5f1b48cd39c053e9

See more details on using hashes here.

Provenance

The following attestation bundles were made for xgic_payload_cms_cli-0.2.0.tar.gz:

Publisher: release.yml on xgic/payload-cms-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 xgic_payload_cms_cli-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for xgic_payload_cms_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a21f0080c15f8ed9aff7709fd059f86ce299a83cb1ae60b9b155750269e80b09
MD5 63be4fd92c928e2842b0a1b10e6535e1
BLAKE2b-256 15e4933cdb588ee99e34143154dbc280fa4456a7114328d5fee0126fa6a93309

See more details on using hashes here.

Provenance

The following attestation bundles were made for xgic_payload_cms_cli-0.2.0-py3-none-any.whl:

Publisher: release.yml on xgic/payload-cms-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