diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 257d05c..8820633 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -114,5 +114,13 @@ function sidebarCommands(): DefaultTheme.SidebarItem[] { text: 'Version', link: 'version', }, + { + text: 'Doctor', + link: 'doctor', + }, + { + text: 'Changelog', + link: 'changelog', + }, ]; } diff --git a/src/commands/changelog.md b/src/commands/changelog.md new file mode 100644 index 0000000..3b237a6 --- /dev/null +++ b/src/commands/changelog.md @@ -0,0 +1,60 @@ +# `changelog` + +## Description + +Prints the changelog for BuildCLI. + +## Usage + +```bash +buildcli changelog [options] +``` + +## Options + +| Option | Description | +|--------------------|---------------------------------------------------------------------------------------------------------------------------| +| `--version`, `-v` | Release version to label the generated changelog (e.g., 1.2.3). If not specified, use the latest Git tag or 'Unreleased'. | +| `--format`, `-f` | Output format. Supported: markdown, html and json. (default: markdown) | +| `--output`, `-o` | The output file to write the changelog to. If not specified, will use 'CHANGELOG.\'. | +| `--include`, `-i` | Comma-separated list of commit types to include (default: all). | + +## Examples + +### Example 1 + +Generate a changelog in markdown format. + +```bash +buildcli changelog +``` + +### Example 2 + +Generate a changelog for a specific version. + +```bash +buildcli changelog --version 1.2.3 +``` + +### Example 3 + +Generate a changelog in HTML format and save to a specific file. + +```bash +buildcli changelog --format html --output changelog.html +``` + +### Example 4 + +Include only specific commit types in the changelog. + +```bash +buildcli changelog --include feat,fix +``` + +## See Also + +- [doctor](doctor.md) +- [project](project.md) +- [autocomplete](autocomplete.md) diff --git a/src/commands/doctor.md b/src/commands/doctor.md new file mode 100644 index 0000000..e5bb068 --- /dev/null +++ b/src/commands/doctor.md @@ -0,0 +1,41 @@ +# `doctor` + +## Description + +Analyzes the environment to ensure all necessary tools and dependencies are available and functioning correctly. Provides subcommands for diagnosing issues and applying fixes, ensuring smooth execution of other commands. + +## Usage + +```bash +buildcli doctor [subcommand] +``` + +## Options + +| Option | Description | +|-----------------|----------------------------------------------------------------------------------------------------------| +| `scan` | Performs a comprehensive scan of the environment to check for required tools, their installation status, versions, and readiness (e.g., running state for Docker). Provides detailed instructions for installing missing tools. | +| `fix` | Scans the environment for required tools and dependencies, identifies issues, and attempts to automatically resolve them. This command ensures the build system is properly configured and ready for use. | + +## Examples + +### Example 1 + +Perform a comprehensive scan to ensure all necessary tools are installed and configured correctly. + +```bash +buildcli doctor scan +``` + +### Example 2 + +Automatically identify and resolve issues with required tools and dependencies. + +```bash +buildcli doctor fix +``` + +## See Also + +- [project](project.md) +- [autocomplete](autocomplete.md)