xgic-gitlab-cli 0.1.1__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,30 @@
1
+ # Python
2
+ __pycache__/
3
+ *.py[cod]
4
+ *.egg-info/
5
+ .eggs/
6
+ dist/
7
+ build/
8
+ .pytest_cache/
9
+ .ruff_cache/
10
+ .coverage
11
+ htmlcov/
12
+ .venv/
13
+ venv/
14
+
15
+ # Env / secrets
16
+ .env
17
+ .env.*
18
+ *.pem
19
+
20
+ # Editors
21
+ .idea/
22
+ .vscode/*
23
+ !.vscode/extensions.json
24
+
25
+ # OS
26
+ .DS_Store
27
+ Thumbs.db
28
+
29
+ # .xgic/ directory for temporary Grok Build status reports (mandatory per new standard). All reports are temporary working artifacts only and must never be committed. This is required for the mandatory session status report functionality.
30
+ .xgic/
@@ -0,0 +1,202 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 XGIC
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
202
+
@@ -0,0 +1,8 @@
1
+ XGIC GitLab CLI
2
+ Copyright 2026 XGIC
3
+
4
+ This product includes software and documentation developed at XGIC
5
+ (https://xgic.net).
6
+
7
+ Licensed under the Apache License, Version 2.0.
8
+ See the LICENSE file for details.
@@ -0,0 +1,206 @@
1
+ Metadata-Version: 2.5
2
+ Name: xgic-gitlab-cli
3
+ Version: 0.1.1
4
+ Summary: XGIC CLI GitLab module - GitLab ops commands and helpers (xgic.cli.gitlab).
5
+ Project-URL: Homepage, https://github.com/xgic/gitlab-cli
6
+ Project-URL: Repository, https://github.com/xgic/gitlab-cli
7
+ Project-URL: Issues, https://github.com/xgic/gitlab-cli/issues
8
+ Project-URL: Documentation, https://github.com/xgic/gitlab-cli#readme
9
+ Project-URL: Changelog, https://github.com/xgic/gitlab-cli/releases
10
+ Author: XGIC
11
+ License: Apache-2.0
12
+ License-File: LICENSE
13
+ License-File: NOTICE
14
+ Keywords: cli,gitlab,orchestration,xgic
15
+ Classifier: Development Status :: 3 - Alpha
16
+ Classifier: Environment :: Console
17
+ Classifier: Intended Audience :: Developers
18
+ Classifier: License :: OSI Approved :: Apache Software License
19
+ Classifier: Operating System :: OS Independent
20
+ Classifier: Programming Language :: Python :: 3
21
+ Classifier: Programming Language :: Python :: 3.14
22
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
23
+ Classifier: Typing :: Typed
24
+ Requires-Python: >=3.14
25
+ Requires-Dist: rich>=13.7
26
+ Requires-Dist: xgic-cli>=0.2.0
27
+ Provides-Extra: dev
28
+ Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
29
+ Requires-Dist: pytest>=8.0.0; extra == 'dev'
30
+ Requires-Dist: ruff>=0.4.0; extra == 'dev'
31
+ Provides-Extra: graphql
32
+ Requires-Dist: xgic-gitlab-graphql>=0.1.0; extra == 'graphql'
33
+ Provides-Extra: test
34
+ Requires-Dist: pytest>=8.0.0; extra == 'test'
35
+ Description-Content-Type: text/markdown
36
+
37
+ # XGIC GitLab CLI
38
+
39
+ [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
40
+ [![CI](https://github.com/xgic/gitlab-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/xgic/gitlab-cli/actions/workflows/ci.yml)
41
+ [![Python](https://img.shields.io/badge/python-3.14+-blue?logo=python&logoColor=white)](https://www.python.org/)
42
+
43
+ **GitLab product commands for the modular [XGIC CLI](https://github.com/xgic/cli)—ops under
44
+ `xgic gitlab …`.**
45
+
46
+ Namespace: **`xgic.cli.gitlab`** · Console group: **`xgic gitlab …`** · Brand: **XGIC CLI only**
47
+ ([ADR-0005](https://github.com/xgic/ai/blob/main/docs/adr/0005-modular-xgic-cli-and-retirement-of-xde.md))
48
+
49
+ Standards hub: [xgic/ai](https://github.com/xgic/ai) ·
50
+ [README standards](https://github.com/xgic/ai/blob/main/docs/readme-standards.md)
51
+
52
+ ---
53
+
54
+ ## Vision
55
+
56
+ Self-managed GitLab operators need a **stable, public-safe command surface** for versioned ops—
57
+ not a grab bag of one-off scripts. This module owns the **GitLab product** namespace under `xgic`.
58
+ The GraphQL client library lives in [gitlab-graphql](https://github.com/xgic/gitlab-graphql);
59
+ the Compose **template** and orchestration **image producer** live in
60
+ [gitlab](https://github.com/xgic/gitlab) and [gitlab-dev](https://github.com/xgic/gitlab-dev).
61
+
62
+ One brand (`xgic`), clear ownership, and no private hosts or tracker IDs in the package.
63
+
64
+ ---
65
+
66
+ ## Why this module exists
67
+
68
+ | Benefit | Detail |
69
+ |---------|--------|
70
+ | **Domain clarity** | Nested under `xgic gitlab`—no clash with core or Payload commands |
71
+ | **Composable stack** | Depends on `xgic-cli`; optional GraphQL extra when automation lands |
72
+ | **Public-safe by design** | Endpoints via env/flags—never hard-coded private inventory |
73
+ | **AI + human parity** | Same command map in README and [AGENTS.md](AGENTS.md) |
74
+ | **Open-source rigor** | Apache-2.0, Python 3.14+, RC → TestPyPI → PyPI |
75
+
76
+ ---
77
+
78
+ ## Ecosystem
79
+
80
+ | Package / repo | Role |
81
+ |----------------|------|
82
+ | [xgic/cli](https://github.com/xgic/cli) | Thin core framework (`xgic`) |
83
+ | [xgic/gitlab-graphql](https://github.com/xgic/gitlab-graphql) | GraphQL client library |
84
+ | **This repo** | GitLab product module (`xgic.cli.gitlab`) |
85
+ | [xgic/gitlab-dev](https://github.com/xgic/gitlab-dev) | Orchestration image **producer** (`ghcr.io/xgic/xgic-gitlab`) |
86
+ | [xgic/gitlab](https://github.com/xgic/gitlab) | End-user Docker Compose **template** |
87
+
88
+ Architecture: [ADR-0001](https://github.com/xgic/ai/blob/main/docs/adr/0001-xgic-gitlab-architecture-and-repository-naming.md)
89
+ · [ADR-0005](https://github.com/xgic/ai/blob/main/docs/adr/0005-modular-xgic-cli-and-retirement-of-xde.md).
90
+
91
+ ---
92
+
93
+ ## Quick start
94
+
95
+ ### Development (editable) — current primary path
96
+
97
+ ```bash
98
+ uv pip install -e ../cli
99
+ uv pip install -e ".[dev]"
100
+ xgic gitlab --help
101
+ xgic gitlab info
102
+ ```
103
+
104
+ Optional GraphQL extra (when GraphQL-backed commands ship):
105
+
106
+ ```bash
107
+ uv pip install -e ".[graphql]"
108
+ ```
109
+
110
+ ### Install (PyPI)
111
+
112
+ PyPI publish follows the hub
113
+ [python-package-release.md](https://github.com/xgic/ai/blob/main/docs/python-package-release.md)
114
+ path (RC → TestPyPI → PyPI). Until the first release is published:
115
+
116
+ ```bash
117
+ # After first PyPI release:
118
+ uv pip install "xgic-cli>=0.2.0" "xgic-gitlab-cli"
119
+ xgic gitlab --help
120
+ ```
121
+
122
+ ### Requirements
123
+
124
+ - Python **3.14+**
125
+ - `xgic-cli` ≥ 0.2.0
126
+ - Docker / Docker Compose for stack ops (`health` / `backup` / `restore`)
127
+
128
+ ---
129
+
130
+ ## Console commands
131
+
132
+ All product commands nest under **`xgic gitlab`**:
133
+
134
+ | Command | Purpose |
135
+ |---------|---------|
136
+ | `xgic gitlab info` | Module version and status (`--json` supported) |
137
+ | `xgic gitlab health` | Compose service checks + optional HTTP `/-/health` |
138
+ | `xgic gitlab backup` | `gitlab-backup create` via `docker compose exec` |
139
+ | `xgic gitlab restore <id>` | Destructive restore (`--yes` required; prefer `--dry-run` first) |
140
+
141
+ ### Configuration (no private host defaults)
142
+
143
+ | Setting | Flag | Environment |
144
+ |---------|------|-------------|
145
+ | Compose file | `--compose-file` | `XGIC_GITLAB_COMPOSE_FILE` (default `docker-compose.yml`) |
146
+ | Project name | `--project` | `XGIC_GITLAB_COMPOSE_PROJECT` (default `xgic-gitlab`) |
147
+ | GitLab EE service | `--gitlab-service` | `XGIC_GITLAB_EE_SERVICE` (default `gitlab-ee`) |
148
+ | Orchestration service | `--xgic-service` | `XGIC_GITLAB_ORCH_SERVICE` (default `xgic-gitlab`) |
149
+ | Backup dir hint | `--backup-dir` | `XGIC_GITLAB_BACKUP_DIR` |
150
+ | GitLab URL | `--url` | `GITLAB_URL` (**no default**) |
151
+ | Token | `--token` | `GITLAB_TOKEN` (never logged) |
152
+
153
+ Shared: `--dry-run`, `--json`.
154
+
155
+ ### Examples
156
+
157
+ ```bash
158
+ # From a checked-out xgic/gitlab template directory
159
+ export GITLAB_URL=http://localhost:8929
160
+ xgic gitlab health --json
161
+ xgic gitlab backup --dry-run
162
+ xgic gitlab restore 20240101_1200 --dry-run
163
+ # after confirmation:
164
+ xgic gitlab restore 20240101_1200 --yes
165
+ ```
166
+
167
+ ---
168
+
169
+ ## Status
170
+
171
+ **0.1.1 — experimental.** Nested `xgic gitlab` commands: `info`, `health`, `backup`, `restore` against
172
+ Docker Compose stacks (typically [xgic/gitlab](https://github.com/xgic/gitlab)).
173
+
174
+ ---
175
+
176
+ ## AI agent guidance
177
+
178
+ - Use **`xgic gitlab …`** for product ops; do not hardcode private GitLab hostnames in public
179
+ artifacts or committed examples.
180
+ - Prefer **fictional placeholders** (`https://gitlab.example.com`) in docs and tests.
181
+ - Destructive restore always needs **`--yes`**; start with **`--dry-run`**.
182
+ - Follow hub
183
+ [public-safe](https://github.com/xgic/ai/blob/main/docs/BASE-STANDARDS-FOR-ORCHESTRATED-REPOS.md)
184
+ rules before any public GitHub write.
185
+
186
+ ---
187
+
188
+ ## Public safety
189
+
190
+ This package is **public-safe only**. Do not hardcode private GitLab hosts, internal inventory, or
191
+ private tracker IDs. Operators configure endpoints via environment / flags.
192
+
193
+ ---
194
+
195
+ ## Publishing
196
+
197
+ Follow
198
+ [python-package-release.md](https://github.com/xgic/ai/blob/main/docs/python-package-release.md)
199
+ (publish **after** `xgic-cli` for stack releases). Tags: `vX.Y.ZrcN` → TestPyPI; `vX.Y.Z` → PyPI.
200
+
201
+ ---
202
+
203
+ ## License
204
+
205
+ Apache License 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
206
+ Copyright form: `Copyright 2026 XGIC`.
@@ -0,0 +1,170 @@
1
+ # XGIC GitLab CLI
2
+
3
+ [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
4
+ [![CI](https://github.com/xgic/gitlab-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/xgic/gitlab-cli/actions/workflows/ci.yml)
5
+ [![Python](https://img.shields.io/badge/python-3.14+-blue?logo=python&logoColor=white)](https://www.python.org/)
6
+
7
+ **GitLab product commands for the modular [XGIC CLI](https://github.com/xgic/cli)—ops under
8
+ `xgic gitlab …`.**
9
+
10
+ Namespace: **`xgic.cli.gitlab`** · Console group: **`xgic gitlab …`** · Brand: **XGIC CLI only**
11
+ ([ADR-0005](https://github.com/xgic/ai/blob/main/docs/adr/0005-modular-xgic-cli-and-retirement-of-xde.md))
12
+
13
+ Standards hub: [xgic/ai](https://github.com/xgic/ai) ·
14
+ [README standards](https://github.com/xgic/ai/blob/main/docs/readme-standards.md)
15
+
16
+ ---
17
+
18
+ ## Vision
19
+
20
+ Self-managed GitLab operators need a **stable, public-safe command surface** for versioned ops—
21
+ not a grab bag of one-off scripts. This module owns the **GitLab product** namespace under `xgic`.
22
+ The GraphQL client library lives in [gitlab-graphql](https://github.com/xgic/gitlab-graphql);
23
+ the Compose **template** and orchestration **image producer** live in
24
+ [gitlab](https://github.com/xgic/gitlab) and [gitlab-dev](https://github.com/xgic/gitlab-dev).
25
+
26
+ One brand (`xgic`), clear ownership, and no private hosts or tracker IDs in the package.
27
+
28
+ ---
29
+
30
+ ## Why this module exists
31
+
32
+ | Benefit | Detail |
33
+ |---------|--------|
34
+ | **Domain clarity** | Nested under `xgic gitlab`—no clash with core or Payload commands |
35
+ | **Composable stack** | Depends on `xgic-cli`; optional GraphQL extra when automation lands |
36
+ | **Public-safe by design** | Endpoints via env/flags—never hard-coded private inventory |
37
+ | **AI + human parity** | Same command map in README and [AGENTS.md](AGENTS.md) |
38
+ | **Open-source rigor** | Apache-2.0, Python 3.14+, RC → TestPyPI → PyPI |
39
+
40
+ ---
41
+
42
+ ## Ecosystem
43
+
44
+ | Package / repo | Role |
45
+ |----------------|------|
46
+ | [xgic/cli](https://github.com/xgic/cli) | Thin core framework (`xgic`) |
47
+ | [xgic/gitlab-graphql](https://github.com/xgic/gitlab-graphql) | GraphQL client library |
48
+ | **This repo** | GitLab product module (`xgic.cli.gitlab`) |
49
+ | [xgic/gitlab-dev](https://github.com/xgic/gitlab-dev) | Orchestration image **producer** (`ghcr.io/xgic/xgic-gitlab`) |
50
+ | [xgic/gitlab](https://github.com/xgic/gitlab) | End-user Docker Compose **template** |
51
+
52
+ Architecture: [ADR-0001](https://github.com/xgic/ai/blob/main/docs/adr/0001-xgic-gitlab-architecture-and-repository-naming.md)
53
+ · [ADR-0005](https://github.com/xgic/ai/blob/main/docs/adr/0005-modular-xgic-cli-and-retirement-of-xde.md).
54
+
55
+ ---
56
+
57
+ ## Quick start
58
+
59
+ ### Development (editable) — current primary path
60
+
61
+ ```bash
62
+ uv pip install -e ../cli
63
+ uv pip install -e ".[dev]"
64
+ xgic gitlab --help
65
+ xgic gitlab info
66
+ ```
67
+
68
+ Optional GraphQL extra (when GraphQL-backed commands ship):
69
+
70
+ ```bash
71
+ uv pip install -e ".[graphql]"
72
+ ```
73
+
74
+ ### Install (PyPI)
75
+
76
+ PyPI publish follows the hub
77
+ [python-package-release.md](https://github.com/xgic/ai/blob/main/docs/python-package-release.md)
78
+ path (RC → TestPyPI → PyPI). Until the first release is published:
79
+
80
+ ```bash
81
+ # After first PyPI release:
82
+ uv pip install "xgic-cli>=0.2.0" "xgic-gitlab-cli"
83
+ xgic gitlab --help
84
+ ```
85
+
86
+ ### Requirements
87
+
88
+ - Python **3.14+**
89
+ - `xgic-cli` ≥ 0.2.0
90
+ - Docker / Docker Compose for stack ops (`health` / `backup` / `restore`)
91
+
92
+ ---
93
+
94
+ ## Console commands
95
+
96
+ All product commands nest under **`xgic gitlab`**:
97
+
98
+ | Command | Purpose |
99
+ |---------|---------|
100
+ | `xgic gitlab info` | Module version and status (`--json` supported) |
101
+ | `xgic gitlab health` | Compose service checks + optional HTTP `/-/health` |
102
+ | `xgic gitlab backup` | `gitlab-backup create` via `docker compose exec` |
103
+ | `xgic gitlab restore <id>` | Destructive restore (`--yes` required; prefer `--dry-run` first) |
104
+
105
+ ### Configuration (no private host defaults)
106
+
107
+ | Setting | Flag | Environment |
108
+ |---------|------|-------------|
109
+ | Compose file | `--compose-file` | `XGIC_GITLAB_COMPOSE_FILE` (default `docker-compose.yml`) |
110
+ | Project name | `--project` | `XGIC_GITLAB_COMPOSE_PROJECT` (default `xgic-gitlab`) |
111
+ | GitLab EE service | `--gitlab-service` | `XGIC_GITLAB_EE_SERVICE` (default `gitlab-ee`) |
112
+ | Orchestration service | `--xgic-service` | `XGIC_GITLAB_ORCH_SERVICE` (default `xgic-gitlab`) |
113
+ | Backup dir hint | `--backup-dir` | `XGIC_GITLAB_BACKUP_DIR` |
114
+ | GitLab URL | `--url` | `GITLAB_URL` (**no default**) |
115
+ | Token | `--token` | `GITLAB_TOKEN` (never logged) |
116
+
117
+ Shared: `--dry-run`, `--json`.
118
+
119
+ ### Examples
120
+
121
+ ```bash
122
+ # From a checked-out xgic/gitlab template directory
123
+ export GITLAB_URL=http://localhost:8929
124
+ xgic gitlab health --json
125
+ xgic gitlab backup --dry-run
126
+ xgic gitlab restore 20240101_1200 --dry-run
127
+ # after confirmation:
128
+ xgic gitlab restore 20240101_1200 --yes
129
+ ```
130
+
131
+ ---
132
+
133
+ ## Status
134
+
135
+ **0.1.1 — experimental.** Nested `xgic gitlab` commands: `info`, `health`, `backup`, `restore` against
136
+ Docker Compose stacks (typically [xgic/gitlab](https://github.com/xgic/gitlab)).
137
+
138
+ ---
139
+
140
+ ## AI agent guidance
141
+
142
+ - Use **`xgic gitlab …`** for product ops; do not hardcode private GitLab hostnames in public
143
+ artifacts or committed examples.
144
+ - Prefer **fictional placeholders** (`https://gitlab.example.com`) in docs and tests.
145
+ - Destructive restore always needs **`--yes`**; start with **`--dry-run`**.
146
+ - Follow hub
147
+ [public-safe](https://github.com/xgic/ai/blob/main/docs/BASE-STANDARDS-FOR-ORCHESTRATED-REPOS.md)
148
+ rules before any public GitHub write.
149
+
150
+ ---
151
+
152
+ ## Public safety
153
+
154
+ This package is **public-safe only**. Do not hardcode private GitLab hosts, internal inventory, or
155
+ private tracker IDs. Operators configure endpoints via environment / flags.
156
+
157
+ ---
158
+
159
+ ## Publishing
160
+
161
+ Follow
162
+ [python-package-release.md](https://github.com/xgic/ai/blob/main/docs/python-package-release.md)
163
+ (publish **after** `xgic-cli` for stack releases). Tags: `vX.Y.ZrcN` → TestPyPI; `vX.Y.Z` → PyPI.
164
+
165
+ ---
166
+
167
+ ## License
168
+
169
+ Apache License 2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE).
170
+ Copyright form: `Copyright 2026 XGIC`.