Pull to switch the lights ↓
Back to projects

Individual / Personal · Maintained

Doc Gen

Doc Gen — Repository Structure Documentation CLI

Configuration-driven CLI for generating, printing, and analyzing repository structure documentation in Markdown.

1 / 2

Swipe to explore. Tap an image for a closer look.

Image 1 of 2
Doc Gen — Repository Structure Documentation CLI

Doc Gen — Repository Structure Documentation CLI

THE PROJECT

Project details

My role
Author & Software Architect
Started
March 2026
Recorded version
v1.0.2
License
MIT

Built with

  • Python
  • Typer
  • Rich
  • TOML
  • Markdown
  • setuptools-scm
  • Pytest
  • Docker
  • Docker Compose
  • Make
  • MkDocs
  • GitHub Actions
  • GitLab CI/CD

INSTALL & RUN

Choose how to run it.

Use the private Python package when access has been approved, or pull a ready-to-run container image.

Python package

Private access
doc-gen
python -m pip install --index-url "https://gitlab.com/api/v4/projects/85837266/packages/pypi/simple" "doc-gen==1.0.2"

Approved GitLab access and configured pip credentials are required. Credentials are never embedded in this command.

Open the GitLab package registry

Container images

Public access

GHCR

Exact stable version
docker pull ghcr.io/devalltect00/doc-gen:v1.0.2
Latest stable version
docker pull ghcr.io/devalltect00/doc-gen:latest

GitLab

Exact stable version
docker pull registry.gitlab.com/devalltect00/doc-gen:v1.0.2
Latest stable version
docker pull registry.gitlab.com/devalltect00/doc-gen:latest