halguru manual
Displays and generates the manual for the halguru program. Usage:
| Options | Default | Description |
|---|---|---|
--help, -h |
Prints help information | |
--error-codes, -e |
Enables detailed output for debugging and troubleshooting purposes. | |
--display-manual, -d |
Display the manual. | |
--generate-file, -g |
Generate the Markdown manual file. | |
--generate-schemas, -s |
Generate JSON schemas for the models into the specified directory. | |
--generate-yaml-docs, -y |
Generate documentation for the hal.guru models. | |
--generate-cli-docs, -c |
Generate documentation for the CLI commands. | |
--generate-version-file, -r |
Generate a version file. | |
--overwrite, -o |
Overwrite an existing manual file. | |
--verbose, -v |
Enables detailed output for debugging and troubleshooting purposes. |
Summary#
Represents the "ManualService" command for the command-line interface of the application. This command enables the user to display or generate a manual for the system, as well as retrieve additional information about errors, usage instructions, and documentation.
Remarks#
The "ManualService" command provides functionality for displaying the manual directly in the consoleService or generating it as a file in Markdown format. It also includes options for displaying error codes and overwriting previous manual files when generating new ones.
Option --help, -h#
Prints help information
Option --error-codes, -e#
Enables detailed output for debugging and troubleshooting purposes.
Represents a configuration option to enable detailed error code display for debugging and troubleshooting.
This property is part of the "ManualService" command settings in the command-line interface. When enabled, it triggers the display of additional error codes that assist in diagnosing issues within the application.
Option --display-manual, -d#
Display the manual.
Specifies whether the manual should be displayed as part of the "ManualService" command in the command-line interface.
This property controls the output of the application manual documentation to the consoleService. It is typically used to provide users with detailed information about the application's functionality and usage.
Option --generate-file, -g#
Generate the Markdown manual file.
- Type:
String
Specifies the file path where the Markdown manual is generated when the "ManualService" command is executed with this option.
Create a documentation file in Markdown format. If a file path is provided, it generates the manual at the specified location. Enable the 'overwrite' option to replace an existing file at the same path.
Option --generate-schemas, -s#
Generate JSON schemas for the models into the specified directory.
- Type:
String
Specifies the directory path where JSON schemas for the models should be generated.
This property is utilized as part of the "ManualService" command settings in the command-line interface. When provided, it triggers the generation of JSON schema files for the application's models, placing them in the specified directory.
Option --generate-yaml-docs, -y#
Generate documentation for the hal.guru models.
- Type:
String
Specifies an option to generate YAML documentation for the hal.guru models.
This property is part of the "ManualCommand" configuration settings in the command-line interface. When provided, it triggers the generation of model documentation in the YAML format, aiding in documenting model structures and configurations programmatically.
Option --generate-cli-docs, -c#
Generate documentation for the CLI commands.
- Type:
String
Configures the generation of documentation for the command-line interface (CLI) commands.
When specified, this property triggers the creation of CLI documentation in the provided directory. It supports automating the documentation process for commands within the application, ensuring that CLI usage and options are well-documented for end users.
Option --generate-version-file, -r#
Generate a version file.
- Type:
String
Specifies the path to generate a version file.
This property defines an option for creating a version file at the specified location, which can be used for versioning and tracking purposes within the application. If set to null, no version file will be generated.
Option --overwrite, -o#
Overwrite an existing manual file.
- Type:
0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Indicates whether an existing manual file should be overwritten when generating the manual.
This property is utilized in conjunction with the --generate-file and --generate-schemas options to determine whether an existing file should be replaced if it already exists. By default, overwriting is disabled.
Option --verbose, -v#
Enables detailed output for debugging and troubleshooting purposes.
- Type:
0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Specifies whether detailed output is enabled for debugging and troubleshooting purposes.
When set to true, additional information about the command execution process is displayed, which can be useful for diagnosing issues or understanding internal operations. By default, the value is false, indicating standard output only.
| Last updated: | 2025-12-05 | |
| Autogenerated: | Yes | |
| AI powered: | Yes | |
| Core version: | 1.75.0 |