XGIC CLI Dev Container module - Docker Compose orchestration and xgic lifecycle commands (xgic.cli.dev).
Project description
XGIC Dev Container CLI
XGIC Dev Container CLI (xgic.cli.dev) provides Docker Compose orchestration and Dev Container–oriented xgic subcommands for the modular XGIC CLI.
Architecture: ADR-0005.
Publishing to PyPI: python-package-release.md
(publish after xgic-cli for stack releases). Tags: vX.Y.ZrcN → TestPyPI; vX.Y.Z → PyPI.
| Package | Role |
|---|---|
| xgic/cli | Thin core framework (xgic) |
| This repo | Dev Container / Compose + lifecycle commands (xgic.cli.dev) |
| xgic/payload-cms-cli | Payload CMS product module |
Status
0.2.0 — B3 lifecycle commands. Product-agnostic Compose library + registered xgic subcommands. Payload CMS–specific env regenerate / setup remains in payload-cms-cli.
Requirements
- Python 3.14+
xgic-cli≥ 0.2.0- Docker / Docker Compose on the host when running lifecycle commands
Install (development)
python -m pip install -e ../cli
python -m pip install -e ".[dev]"
xgic --help
xgic up --help
Console commands (via entry point)
Installed with this package, registered on the core xgic entrypoint:
| Command | Purpose |
|---|---|
xgic up |
Start compose services (detached) |
xgic down |
Stop services (volumes preserved) |
xgic build [--no-cache] |
Build images |
xgic logs |
Follow logs |
xgic shell |
Shell in primary service (--service required if not set) |
xgic clean --yes |
Destructive: volumes + .devcontainer/.env |
xgic check [--json] |
Services + environment diagnostic |
xgic env [--json] |
Environment status (no secret regeneration) |
Common flags (or env vars):
| Flag | Env var | Default |
|---|---|---|
--compose-file |
XGIC_COMPOSE_FILE |
.devcontainer/docker-compose.yml |
--project |
XGIC_COMPOSE_PROJECT |
xgic-dev |
--service |
XGIC_PRIMARY_SERVICE |
(none) |
--profile |
XGIC_COMPOSE_PROFILE |
(none; used by up) |
Library API
from xgic.cli.core import EnvironmentContext
from xgic.cli.dev import DockerComposeController
env = EnvironmentContext.detect()
docker = DockerComposeController(
env=env,
compose_file=".devcontainer/docker-compose.yml",
project_name="my-project",
primary_service="app",
)
docker.up(profile="postgres")
License
Apache License 2.0. See LICENSE and NOTICE.
Copyright form: Copyright 2026 XGIC.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file xgic_dev_cli-0.2.0.tar.gz.
File metadata
- Download URL: xgic_dev_cli-0.2.0.tar.gz
- Upload date:
- Size: 10.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
df6ef4d9419d1e43548ff5f0b8fc769931c7dfb3761f8096f11ed6896c72c58c
|
|
| MD5 |
a0e320d5102db9906983daf5d633b3a0
|
|
| BLAKE2b-256 |
74d9dbcf0eb9f18c84af6f5fe97e3ad9177caf839f6984a4aa3e10f9b62a8673
|
Provenance
The following attestation bundles were made for xgic_dev_cli-0.2.0.tar.gz:
Publisher:
release.yml on xgic/dev-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
xgic_dev_cli-0.2.0.tar.gz -
Subject digest:
df6ef4d9419d1e43548ff5f0b8fc769931c7dfb3761f8096f11ed6896c72c58c - Sigstore transparency entry: 2191026614
- Sigstore integration time:
-
Permalink:
xgic/dev-cli@4c744d83ce07fc90036b19c5ce8b12cb3f831fc8 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/xgic
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@4c744d83ce07fc90036b19c5ce8b12cb3f831fc8 -
Trigger Event:
push
-
Statement type:
File details
Details for the file xgic_dev_cli-0.2.0-py3-none-any.whl.
File metadata
- Download URL: xgic_dev_cli-0.2.0-py3-none-any.whl
- Upload date:
- Size: 14.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b78d21f9007d8e0923470accb89d0313005333e04a30f2cc9bc290642825ef2d
|
|
| MD5 |
7fe1f27b7a9d37c04e756230a9cd6335
|
|
| BLAKE2b-256 |
cb18a3a026fde200d28fe76ef5e1bf15e41bb1579ce12b8db7640a11bdeabc36
|
Provenance
The following attestation bundles were made for xgic_dev_cli-0.2.0-py3-none-any.whl:
Publisher:
release.yml on xgic/dev-cli
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
xgic_dev_cli-0.2.0-py3-none-any.whl -
Subject digest:
b78d21f9007d8e0923470accb89d0313005333e04a30f2cc9bc290642825ef2d - Sigstore transparency entry: 2191026701
- Sigstore integration time:
-
Permalink:
xgic/dev-cli@4c744d83ce07fc90036b19c5ce8b12cb3f831fc8 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/xgic
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release.yml@4c744d83ce07fc90036b19c5ce8b12cb3f831fc8 -
Trigger Event:
push
-
Statement type: