Skip to content

commands.md

Latest commit

 

History

History
153 lines (104 loc) · 2.83 KB

commands.md

File metadata and controls

153 lines (104 loc) · 2.83 KB
Raw

Commands Reference

This document provides a complete reference for all DocGen commands.

Command Overview

doc-gen [OPTIONS] COMMAND [ARGS]...

Main Commands

init

Initialize project configuration.

doc-gen init [OPTIONS]

Options:

  • --mode TEXT - Initialization mode (all, config)
  • --force - Overwrite existing files
  • --ask - Ask before overwriting

Examples:

doc-gen init
doc-gen init --mode config
doc-gen init --mode all --force

structure

Structure-related commands (parent command).

doc-gen structure [OPTIONS] COMMAND [ARGS]...

structure generate

Generate PROJECT_STRUCTURE.md.

doc-gen structure generate [OPTIONS]

Options:

  • --profile [minimal|default|detailed] - Output profile
  • --max-depth INTEGER - Maximum directory depth
  • --smart / --no-smart - Enable smart mode
  • --show-files / --no-files - Show individual files
  • --output FILE - Output file path

Examples:

doc-gen structure generate
doc-gen structure generate --profile minimal
doc-gen structure generate --smart
doc-gen structure generate --max-depth 2
doc-gen structure generate --output my-structure.md

structure print

Print structure to console.

doc-gen structure print [OPTIONS]

Options: Same as generate command.

Examples:

doc-gen structure print
doc-gen structure print --smart
doc-gen structure print --max-depth 3

structure analyze

Analyze project structure.

doc-gen structure analyze [OPTIONS]

Examples:

doc-gen structure analyze
doc-gen structure analyze --smart

Global Options

  • --help - Show help message
  • --version - Show version
  • --no-banner - Hide banner

Makefile Commands

For convenience, use Makefile shortcuts:

Local Commands

make l-generate          # Run generate locally
make l-generate-smart   # Run generate with smart mode
make l-print           # Run print locally
make l-analyze        # Run analyze locally

Docker Commands

make d-generate        # Run generate in Docker
make d-generate-smart # Run generate with smart mode in Docker
make d-print          # Run print in Docker
make d-analyze       # Run analyze in Docker

Docker Compose Commands

make c-generate       # Run generate using compose
make c-generate-smart # Run generate with smart mode using compose
make c-print        # Run print using compose
make c-analyze     # Run analyze using compose

Related Documentation