Installation and First Workflow

Recommended

Use a dedicated environment, inspect the repository, and preview the resolved output before generation.

CommandDoc Gen

Quick Command

doc-gen structure generate . --dry-run

Install a Reviewed Release

Authorized users can install from the private GitLab PyPI registry with the project ID and a deploy token limited to read_package_registry.

Private GitLab package

bash

python -m venv venv

# Activate the environment, then install one reviewed package version.

python -m pip install --index-url "https://<deploy-user>:<deploy-token>@gitlab.com/api/v4/projects/<project-id>/packages/pypi/simple" "doc-gen==1.0.2"

doc-gen --version

A Git tag such as v1.0.0-rc.1 becomes PEP 440 package version 1.0.0rc1. Use doc-gen==1.0.0rc1 when deliberately testing that release candidate. This package is private; do not commit tokens or credential-bearing index URLs.

Install from a Source Checkout

Environment

bash

python -m venv venv
python -m pip install .
doc-gen --version

Safe first workflow

bash

cd /path/to/project
doc-gen init --dry-run
doc-gen init

# Read-only inspection

doc-gen structure print .
doc-gen structure analyze .

# Preview the resolved target and output path

doc-gen structure generate . --output docs/project_structure.md --dry-run

# Generate only after reviewing the preview

doc-gen structure generate . --output docs/project_structure.md