XGIC Wagtail CLI

Wagtail product commands for the modular XGIC CLI—ops under xgic wagtail ….

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

Standards hub: xgic/ai · README standards · Default CMS: ADR-0006

Vision

Wagtail is the default CMS for new XGIC work. This module owns the Wagtail product namespace under xgic so humans and agents share one command map. The thin site template lives in xgic/wagtail; the Dev Container producer (ghcr.io/xgic/wagtail-dev) lives in xgic/wagtail-dev.

Why this module exists

Ecosystem

Architecture: ADR-0001 · ADR-0005 · ADR-0006.

Quick start

Development (editable)

uv pip install -e ../cli
uv pip install -e ".[dev]"
xgic wagtail
xgic wagtail info
xgic wagtail setup
xgic wagtail dev
xgic wagtail backup --help
xgic wagtail restore --backup-dir ./backups --dry-run
xgic wagtail restore --backup-dir ./backups --yes --media replace

xgic wagtail with no action prints full usage and exits 2. xgic wagtail dev waits for PostgreSQL, runs migrate --noinput, then python manage.py runserver 0.0.0.0:8000. Requires a site from setup. xgic wagtail setup is idempotent: config JSON, Compose .env, wagtail start when missing, Django DATABASES on PostgreSQL, and django.contrib.postgres in the generated <project>/settings/base.py INSTALLED_APPS (immediately before django.contrib.admin, for Wagtail search SearchVectorField / GinIndex). SQLite is not an XGIC default. The thin GitHub template does not vendor that settings file. .devcontainer/.env is expected to be missing until the first setup.

Generic xgic logs / xgic check / xgic up (from xgic/dev-cli) talk to the host Docker engine. In the Dev Container that is Docker-outside-of-Docker (CLI + mounted socket from xgic/wagtail-dev); not Docker-in-Docker. Site work stays xgic wagtail setup then xgic wagtail dev.

Install (PyPI)

uv pip install "xgic-wagtail-cli>=0.1.0"
xgic wagtail --help
xgic wagtail info
xgic wagtail setup
xgic wagtail dev

PyPI publish follows the hub python-package-release.md path (RC → TestPyPI → PyPI). The release milestone is titled X.Y.Z, matching the published version. Set it on every issue and pull request in that release. GitHub does not copy the issue milestone onto the pull request. The candidate and the final publish share it. Work tracking.

Commands

dbAdapter is postgres only. Dev-server helpers remain planned.

Contributing

See CONTRIBUTING.md. Human review in the GitHub UI before merge. Labels required. Public-safe content only.

License

Apache License 2.0. See LICENSE and NOTICE.