XGIC GitLab CLI

GitLab product commands for the modular XGIC CLI—ops under xgic gitlab ….

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

Standards hub: xgic/ai · README standards

Vision

Self-managed GitLab operators need a stable, public-safe command surface for versioned ops— not a grab bag of one-off scripts. This module owns the GitLab product namespace under xgic. The GraphQL client library lives in gitlab-graphql; the Compose template and orchestration image producer live in gitlab and gitlab-dev.

One brand (xgic), clear ownership, and no private hosts or tracker IDs in the package.

Why this module exists

Ecosystem

Architecture: ADR-0001 · ADR-0005.

Quick start

Development (editable) — current primary path

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

Optional GraphQL extra (when GraphQL-backed commands ship):

uv pip install -e ".[graphql]"

Install (PyPI)

PyPI publish follows the hub python-package-release.md path (RC → TestPyPI → PyPI). Until the first release is published:

# After first PyPI release:
uv pip install "xgic-cli>=0.2.0" "xgic-gitlab-cli"
xgic gitlab --help

Requirements

• Python 3.14+
• xgic-cli ≥ 0.2.0
• Docker / Docker Compose for stack ops (health / backup / restore)

Console commands

All product commands nest under xgic gitlab:

Configuration (no private host defaults)

Shared: --dry-run, --json.

Examples

# From a checked-out xgic/gitlab template directory
export GITLAB_URL=http://localhost:8929
xgic gitlab health --json
xgic gitlab backup --dry-run
xgic gitlab restore 20240101_1200 --dry-run
# after confirmation:
xgic gitlab restore 20240101_1200 --yes

Status

0.1.1 — experimental. Nested xgic gitlab commands: info, health, backup, restore against Docker Compose stacks (typically xgic/gitlab).

AI agent guidance

• Use xgic gitlab … for product ops; do not hardcode private GitLab hostnames in public artifacts or committed examples.
• Prefer fictional placeholders (https://gitlab.example.com) in docs and tests.
• Destructive restore always needs --yes; start with --dry-run.
• Follow hub public-safe rules before any public GitHub write.

Public safety

This package is public-safe only. Do not hardcode private GitLab hosts, internal inventory, or private tracker IDs. Operators configure endpoints via environment / flags.

Publishing

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

License

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