cmd

Documentation

Index

• func Execute()
• func NewGenerateCmd(filesystem afero.Fs, documentationGenerator gitlab.DocumentationGenerator) *cobra.Command
• func NewRootCmd() *cobra.Command

Functions

func Execute

func Execute()

func NewGenerateCmd

func NewGenerateCmd(filesystem afero.Fs, documentationGenerator gitlab.DocumentationGenerator) *cobra.Command

NewGenerateCmd creates a new command for generating documentation for GitLab CI/CD components. It processes YAML files from a specified directory using a provided or default template.

Parameters:

• filesystem: An interface for interacting with the file system.
• documentationGenerator: An interface for generating documentation.

Returns:

• *cobra.Command: A pointer to the newly created cobra.Command.

func NewRootCmd

func NewRootCmd() *cobra.Command

NewRootCmd creates the root command for the CLI application. This command serves as the entry point and parent for all other commands.

Returns:

• *cobra.Command: A pointer to the newly created cobra.Command.