Skip to main content

XGIC Payload CMS CLI

License PyPI Python CI Release Producer

Payload CMS product commands for the modular XGIC CLI.

Namespace: xgic.cli.payload · Console group: xgic payload … · Brand: XGIC CLI only (ADR-0005)

Standards hub: xgic/ai


Vision

Payload application teams—and the AI agents that help them—need a small, stable command surface for project ensure, environment status, smart dev start, and safe reset. This module owns that product surface. Generic Compose lifecycle stays in dev-cli; the Dev Container image is built in payload-cms-dev; applications start from payload-cms.

One brand (xgic), clear ownership, and dry-run-friendly destructive paths.


Why this module exists

Benefit Detail
Domain clarity Nested under xgic payload—no clash with generic xgic up / down
AI + human parity Same commands in READMEs and AGENTS.md
Safe operations Reset and regenerate paths support explicit confirmation / dry-run patterns
Composable stack Depends on xgic-cli + xgic-dev-cli; ships on PyPI for image and host installs
Open-source rigor Apache-2.0, Python 3.14+, RC → TestPyPI → PyPI

Ecosystem

Package / repo Role
xgic/cli Thin core framework (xgic)
xgic/dev-cli Dev Container / Docker Compose lifecycle
This repo Payload CMS product module (xgic.cli.payload)
xgic/payload-cms-dev Dev Container image producer (ghcr.io/xgic/payload-cms-dev)
xgic/payload-cms End-user template (recommended app start)

Quick start

Install (PyPI)

uv pip install \
  "xgic-cli>=0.2.0,<0.3" \
  "xgic-dev-cli>=0.2.0,<0.3" \
  "xgic-payload-cms-cli>=0.2.2,<0.3"
xgic payload --help

Development (editable)

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

Typical Payload session (inside a Dev Container)

First session (one setup command — creates .devcontainer/.env if missing, starts the DB profile, scaffolds the app):

xgic payload setup
xgic payload dev

Daily (after the app exists):

xgic payload dev

Optional: xgic payload env (status), xgic payload env --regenerate --yes (rotate credentials only — not required for first setup).

Prefer the end-user template for application work: payload-cms.


Console commands

All product commands nest under xgic payload:

Command Purpose
xgic payload dev Primary daily command — smart start (up if needed, DB check, pnpm dev)
xgic payload setup [--quiet] First-run one-shot: env (if missing) + DB profile + scaffold (idempotent)
xgic payload env [--json] Product env status (project name, .env, services)
xgic payload env --regenerate --yes Rotate credentials in .devcontainer/.env (optional; setup creates env when absent)
xgic payload schema Run template schema generator when present
xgic payload reset Fast targeted reset (project folder + active DB volume)

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

Setup: automatic vs manual

Mode Guidance
Automatic Producer/image postStart may call xgic payload setup via a thin shell wrapper (idempotent).
Manual / testing After xgic payload reset --yes, or when validating scaffold config—not a “daily” app ritual.

Always prefer xgic payload reset --dry-run before destructive reset.

Historical command map (xde → XGIC CLI)

Living brand is XGIC CLI only. Historical map for agents migrating old notes:

Historical (xde) XGIC CLI
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,
)

Requirements

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

Publishing

Follow python-package-release.md.

Publish after xgic-cli and xgic-dev-cli for stack releases. Tags: vX.Y.ZrcN → TestPyPI; vX.Y.Z → PyPI.


Working with AI assistants

High-signal prompts:

  • “Run xgic payload env (no secrets) and recommend whether to start Postgres.”
  • “Start with xgic payload dev and report the listen URL.”
  • “Show xgic payload reset --dry-run before any reset.”

Ownership:

Change Repository
xgic payload … behavior This repo
xgic up / down / check dev-cli
Image / Dockerfile payload-cms-dev
App template pin / docs payload-cms

Public-safe gate: BASE-STANDARDS.


Contributing

PRs with human UI review only. Conventional Commits; labels required. See CONTRIBUTING.md and AGENTS.md.


License

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


XGIC — Modular CLI for open-source platforms: thin core, domain modules, and AI-operable Payload workflows.

Release files for xgic-payload-cms-cli 0.2.2

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

Source distribution (sdist)

Source distribution for xgic-payload-cms-cli 0.2.2
File Size Uploaded
xgic_payload_cms_cli-0.2.2.tar.gz 18.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for xgic-payload-cms-cli 0.2.2
File Interpreter ABI Platform
xgic_payload_cms_cli-0.2.2-py3-none-any.whl Python 3 none any Details

Total release size: 44.2 kB

Release files / xgic_payload_cms_cli-0.2.2.tar.gz

Download URL xgic_payload_cms_cli-0.2.2.tar.gz
Size 18.9 kB
Tags Source
SHA-256 checksum
How to use checksums
295d97aab205eda94d7efe4c48686f806e46360701531498674b13f9442caacb
BLAKE2b-256 checksum
How to use checksums
28a7c3d2ed699d2e9c7f47c0630d98752665e6c02b2281ecb50feb9b21fb982d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 17, 2026.

Transparency log

Release files / xgic_payload_cms_cli-0.2.2-py3-none-any.whl

Download URL xgic_payload_cms_cli-0.2.2-py3-none-any.whl
Size 25.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
670fd15fd307c1e4dd5ab926a45f1f708e4d6e586c7d13863463c91806e6dac4
BLAKE2b-256 checksum
How to use checksums
8bae7b7b65a470ccca4a55a619fbaa32df0dfdeeb248eb1938286786ca7eda6f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 17, 2026.

Transparency log

Release history Release notifications | RSS feed

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

This release

0.2.2 This release

2 release files

0.2.1

2 release files

0.2.0

2 release files

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