XGIC Payload CMS CLI

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

Ecosystem

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.5,<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 (rewrite credentials in .devcontainer/.env and sync the app .env — not required for first setup). Regenerate does not delete Compose DB volume data; it also does not change the password already stored in that volume—recreate the volume (xgic payload reset --yes, destructive) or update the DB role to match. Non-destructive live rotation is tracked separately.

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

Console commands

All product commands nest under xgic payload:

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

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:

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:

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.