Skip to content

Commit 75cd68d

Browse files
Copilotchefgs
andcommitted
feat: unify CLI — scaffold becomes a proper Typer sub-app with native per-target options; update all docs
Co-authored-by: chefgs <7605658+chefgs@users.noreply.github.com>
1 parent d8f9441 commit 75cd68d

5 files changed

Lines changed: 704 additions & 597 deletions

File tree

README-INDEX.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,22 @@ Welcome to the DevOps-OS documentation! This set of guides will help you use and
2121

2222
## CLI Generator Quick Reference
2323

24+
All commands are accessed through the unified `devopsos` CLI:
25+
26+
```bash
27+
python -m cli.devopsos scaffold --help # list all scaffold targets
28+
python -m cli.devopsos scaffold gha --help # see all GHA options
29+
```
30+
2431
| Command | Default output |
2532
|---------|---------------|
26-
| `python -m cli.scaffold_gha` | `.github/workflows/<name>-<type>.yml` |
27-
| `python -m cli.scaffold_gitlab` | `.gitlab-ci.yml` |
28-
| `python -m cli.scaffold_jenkins` | `Jenkinsfile` |
29-
| `python -m cli.scaffold_argocd` | `argocd/` directory |
30-
| `python -m cli.scaffold_argocd --method flux` | `flux/` directory |
31-
| `python -m cli.scaffold_sre` | `sre/` directory |
32-
| `python -m cli.scaffold_devcontainer` | `.devcontainer/` directory |
33+
| `python -m cli.devopsos scaffold gha` | `.github/workflows/<name>-<type>.yml` |
34+
| `python -m cli.devopsos scaffold gitlab` | `.gitlab-ci.yml` |
35+
| `python -m cli.devopsos scaffold jenkins` | `Jenkinsfile` |
36+
| `python -m cli.devopsos scaffold argocd` | `argocd/` directory |
37+
| `python -m cli.devopsos scaffold argocd --method flux` | `flux/` directory |
38+
| `python -m cli.devopsos scaffold sre` | `sre/` directory |
39+
| `python -m cli.devopsos scaffold devcontainer` | `.devcontainer/` directory |
3340

3441
See [CLI Commands Reference](docs/CLI-COMMANDS-REFERENCE.md) for the full option tables, input files, and output path details.
3542

@@ -41,15 +48,15 @@ cd devops_os
4148
pip install -r cli/requirements.txt
4249

4350
# GitHub Actions complete pipeline
44-
python -m cli.scaffold_gha --name my-app --languages python,javascript --type complete
51+
python -m cli.devopsos scaffold gha --name my-app --languages python,javascript --type complete
4552
# Output: .github/workflows/my-app-complete.yml
4653

4754
# GitLab CI pipeline
48-
python -m cli.scaffold_gitlab --name my-app --languages python
55+
python -m cli.devopsos scaffold gitlab --name my-app --languages python
4956
# Output: .gitlab-ci.yml
5057

5158
# SRE monitoring stack
52-
python -m cli.scaffold_sre --name my-app --team platform
59+
python -m cli.devopsos scaffold sre --name my-app --team platform
5360
# Output: sre/ directory
5461
```
5562

0 commit comments

Comments
 (0)