diff --git a/src/commands/about.md b/src/commands/about.md index dfb27fb..2dcee91 100644 --- a/src/commands/about.md +++ b/src/commands/about.md @@ -1,10 +1,18 @@ # `about` -## Description +## Table of Contents +- [Description](#description) +- [Usage](#usage) +- [Options](#options) +- [Examples](#examples) +- [Troubleshooting](#troubleshooting) +- [See Also](#see-also) -Displays information about BuildCLI. +## Description +## Description +Displays comprehensive information about BuildCLI, a command-line interface (CLI) designed to simplify the build process for Java developers. BuildCLI offers a variety of features that enhance productivity and streamline workflows, including project management, dependency handling, and automated build processes. ## Usage ```bash @@ -23,12 +31,32 @@ buildcli about ### Example 1 Display information about BuildCLI. - ```bash buildcli about ``` -## See Also +### Example 2 + +Display the version of BuildCLI. +```bash +buildcli about --version +``` +### Example 3 +Display help information for the command. +```bash +buildcli about --help +``` + +## Troubleshooting +If you encounter issues running the command, ensure that BuildCLI is correctly installed and added to your system’s PATH. + +## Related Commands - [project](project.md) +- [autocomplete](autocomplete.md) + + +## See Also + +- [Installation](installation.md) - [autocomplete](autocomplete.md) \ No newline at end of file diff --git a/src/commands/autocomplete.md b/src/commands/autocomplete.md index bc92998..f7d1bc7 100644 --- a/src/commands/autocomplete.md +++ b/src/commands/autocomplete.md @@ -1,8 +1,16 @@ # `autocomplete` +## Table of Contents +- [Description](#description) +- [Usage](#usage) +- [Options](#options) +- [Examples](#examples) +- [Troubleshooting](#troubleshooting) +- [See Also](#see-also) ## Description -Configures shell autocomplete for BuildCLI commands. +Configures shell autocomplete for BuildCLI commands. This feature enhances the user experience by allowing users to quickly access available commands and options without needing to remember them. + ## Usage @@ -19,14 +27,24 @@ buildcli autocomplete ## Examples -### Example 1 +### Example 1: Configure Autocomplete -Configure autocomplete for supported shells. +To configure autocomplete for supported shells, simply run: ```bash buildcli autocomplete ``` + +### Example 2: Check Autocomplete +After running the configuration command, you can test it by typing `buildcli` followed by a space and then pressing the Tab key to see the available commands. + +### Troubleshooting +If autocomplete does not work as expected: + +* Ensure that your shell configuration file `(e.g., .bashrc, .zshrc)` has been updated correctly. +* Restart your terminal or source your configuration file again. +* Verify that BuildCLI is correctly installed and accessible in your system’s PATH. For installation instructions, see the [installation](../installation.md) section. ## See Also - [project](project.md) diff --git a/src/commands/build.md b/src/commands/build.md new file mode 100644 index 0000000..37bd238 --- /dev/null +++ b/src/commands/build.md @@ -0,0 +1,71 @@ +# `build` + +## Table of Contents +- [Description](#description) +- [Usage](#usage) +- [Options](#options) +- [Arguments](#arguments) +- [Examples](#examples) +- [Troubleshooting](#troubleshooting) +- [See Also](#see-also) +## Description + +Handles the building and compiling of projects within BuildCLI. This command allows users to compile their project source code, manage build configurations, and ensure that the project is ready for execution or deployment. + +## Usage + +```bash +buildcli build [options] +``` + +## Options + +| Option | Description | +|--------------------|-----------------------------------------------| +| `-h, --help` | Display help information about the command. | +| `-V, --version` | Display the version of the command. | +| `--clean` | Cleans the build directory before building. | +| `--skip-tests` | Skips running tests during the build process. | +| `--profile ` | Specifies the build profile to use. | + + +### Examples +### Example 1: Build the Project +To build the project: + +```bash +buildcli build +``` +This command compiles the project source code and prepares it for execution. + +### Example 2: Clean and Build the Project +To clean the build directory and then build the project: +```bash +buildcli build --clean +``` +This command removes any previous build artifacts before compiling the project. + +### Example 3: Build with a Specific Profile +To build the project using a specific profile: +```bash +buildcli build --profile production +``` + +### Example 4: Build and Skip Tests +To build the project while skipping tests: +```bash +buildcli build --skip-tests +``` +This command compiles the project without running any tests. + +### Troubleshooting +If you encounter issues while building the project: + +* Ensure that your project is correctly initialized and contains the necessary files. +* Check for any errors in the build output for guidance on what went wrong. +* Refer to the help for the build command using `buildcli build --help` for more information. + +### See Also +- [project](project.md) +- [run](run.md) +- [test](test.md) \ No newline at end of file diff --git a/src/commands/project.md b/src/commands/project.md index e992124..8d9b35a 100644 --- a/src/commands/project.md +++ b/src/commands/project.md @@ -1,9 +1,16 @@ - +[ # `project` - +## Table of Contents +- [Description](#description) +- [Usage](#usage) +- [Options](#options) +- [Examples](#examples) +- [Troubleshooting](#troubleshooting) +- [See Also](#see-also) ## Description -Manages Java projects with various subcommands. +Manages project-specific settings and configurations for BuildCLI. This command allows users to create, manage, and view project details, ensuring that the CLI operates within the correct project context. + ## Usage @@ -35,15 +42,50 @@ buildcli project [subcommand] [options] [arguments] ## Examples -### Example 1 +### Example 1: Initialize a New Project + +To create a new Java project, use the init subcommand: + +```bash +buildcli project init --name MyNewProject +``` +To add a new project: -Initialize a new project. +### Example 2: Add a New Project +```bash +buildcli project add --name MyProject --path /path/to/myproject +``` +This command adds a project named MyProject located at the specified path to the project list. +### Example 3: Remove an Existing Project +To remove an existing project from the project list: ```bash -buildcli project init +buildcli project remove --name MyProject ``` +### Example 4: Build the Project +To build the project: +```bash +buildcli project build +``` + + +### Example 5: Run the Project +To run the project: +```bash +buildcli project run +``` + +### Troubleshooting +If you encounter issues while using the project commands: + +* Ensure that you have initialized the project correctly using the init command. +* Check that the necessary files and directories are in place. +* Refer to the specific subcommand help using buildcli project [subcommand] `--help` for more information. + + ## See Also - [autocomplete](autocomplete.md) -- [about](about.md) \ No newline at end of file +- [about](about.md) +- [version](version.md)]() \ No newline at end of file diff --git a/src/commands/run.md b/src/commands/run.md new file mode 100644 index 0000000..e1d6bf3 --- /dev/null +++ b/src/commands/run.md @@ -0,0 +1,70 @@ +# `run` + +## Table of Contents +- [Description](#description) +- [Usage](#usage) +- [Options](#options) +- [Examples](#examples) +- [Troubleshooting](#troubleshooting) +- [See Also](#see-also) + +## Description + +Handles the execution of projects within BuildCLI. This command allows users to run their Java applications directly from the command line, facilitating testing and development workflows. + +## Usage +```bash +buildcli run [options] +``` + +## Options + +| Option | Description | +|--------------------|-----------------------------------------------------| +| `-h, --help` | Display help information about the command. | +| `-V, --version` | Display the version of the command. | +| `--profile ` | Specifies the profile to use during execution. | +| `--debug` | Skips running tests during the build process. | +| `--port ` | Specifies the port on which to run the application. | + + +### Examples +### Example 1: Run the Project +To run the project: +```bash +buildcli run +``` +This command executes the main application. + +### Example 2: Run with a Specific Profile +To run the project using a specific profile: +```bash +buildcli run --profile development +``` +This command executes the application with the settings defined in the `development` profile. + +### Example 3: Run in Debug Mode +To run the project in debug mode: +```bash +buildcli run --debug +``` +This command starts the application with debugging enabled, allowing for step-by-step execution. + +### Example 4: Run on a Specific Port +To run the project on a specific port: +```bash +buildcli run --port 8080 +``` +This command executes the application and binds it to port 8080. + +### Troubleshooting +If you encounter issues while running the project: + +* Ensure that the project has been built successfully before running. +* Check for any runtime errors in the console output. +* Refer to the help for the run command using `buildcli run --help` for more information. + +### See Also +- [build](build.md) +- [test](test.md) +- [project](project.md) \ No newline at end of file diff --git a/src/commands/set.md b/src/commands/set.md new file mode 100644 index 0000000..bafbfdd --- /dev/null +++ b/src/commands/set.md @@ -0,0 +1,63 @@ +# `set` + +## Table of Contents +- [Description](#description) +- [Usage](#usage) +- [Options](#options) +- [Examples](#examples) +- [Troubleshooting](#troubleshooting) +- [See Also](#see-also) +## Description + +Handles the configuration settings of projects within BuildCLI. This command allows users to set various properties and parameters of their projects, ensuring that they are tailored to specific requirements. + +## Usage +```bash +buildcli set [options] +``` + +### Options + +| Option | Description | +|---------------------|-----------------------------------------------------| +| `-h, --help` | Display help information about the command. | +| `-V, --version` | Display the version of the command. | +| `--property ` | Specifies the property to set. | +| `--value ` | Specifies the value for the property. | +| `--reset` | Resets the specified property to its default value. | + +### Examples +### Example 1: Set a Project Property +To set a property for the project: + +```bash +buildcli set --property version --value 1.0.0 +``` +This command sets the project version to `1.0.0`. + +### Example 2: Reset a Project Property +To reset a specific property to its default value: + +```bash +buildcli set --property version --reset +``` +This command resets the project version property to its default value. + +### Example 3: Set Multiple Properties +To set multiple properties at once: +```bash +buildcli set --property name --value MyProject --property description --value "This is my project" +``` +This command sets the project name and description simultaneously. + +### Troubleshooting +If you encounter issues while setting project properties: + +* Ensure that the property name is valid and recognized by the project configuration. +* Check for any errors in the command output for guidance on what went wrong. +* Refer to the help for the set command using `buildcli set --help` for more information + +### See Also +- [build](build.md) +- [run](run.md) +- [project](project.md) \ No newline at end of file diff --git a/src/commands/template.md b/src/commands/template.md index 78abcf4..7c694d4 100644 --- a/src/commands/template.md +++ b/src/commands/template.md @@ -1,8 +1,15 @@ -# `command-name` - +# `template` +## Table of Contents +- [Description](#description) +- [Usage](#usage) +- [Options](#options) +- [Arguments](#arguments) +- [Examples](#examples) +- [Troubleshooting](#troubleshooting) +- [See Also](#see-also) ## Description -Provide a brief description of what the command does. +Provide a clear and concise description of what the command does, including its purpose and any relevant context that may help users understand its functionality. ## Usage @@ -20,28 +27,31 @@ buildcli command-name [options] [arguments] ## Arguments -| Argument | Description | -|-------------|-------------------------------------| -| `argument1` | Description of the first argument. | -| `argument2` | Description of the second argument. | +| Argument | Description | +|-------------|------------------------------------------------------------------------------------| +| `argument1` | Description of the first argument, including any constraints or expected formats. | +| +| `argument2` | Description of the second argument, including any constraints or expected formats. | +| ## Examples -### Example 1 +### Example 1: Basic Usage -Description of what this example does. +Provide a brief description of what this example demonstrates. ```bash command-name -o value argument1 argument2 ``` -### Example 2 - -Description of what this example does. +### Example 2: Alternative Syntax +Provide a brief description of what this example demonstrates. ```bash command-name --option=value argument1 ``` +### Troubleshooting +Include common issues users may encounter when using this command, along with potential solutions or tips for resolving them. ## See Also diff --git a/src/commands/test.md b/src/commands/test.md new file mode 100644 index 0000000..5429277 --- /dev/null +++ b/src/commands/test.md @@ -0,0 +1,71 @@ +# `test` + +## Table of Contents +- [Description](#description) +- [Usage](#usage) +- [Options](#options) +- [Examples](#examples) +- [Troubleshooting](#troubleshooting) +- [See Also](#see-also) +## Description + +Handles the testing of projects within BuildCLI. This command allows users to run unit tests, integration tests, and other testing frameworks to ensure the quality and functionality of their applications. + +## Usage + +```bash +buildcli test [options] +``` + +### Options + +| Option | Description | +|----------------------|----------------------------------------------| +| `-h, --help` | Display help information about the command. | +| `-V, --version` | Display the version of the command. | +| `--skip-integration` | Skips running integration tests. | +| `--profile ` | Specifies the profile to use during testing. | +| `--report` | Generates a test report after execution. | + +### Examples +### Example 1: Run All Tests +To run all tests in the project: +```bash +buildcli test +``` +This command executes all unit and integration tests defined in the project. + +### Example 2: Skip Integration Tests +To run only unit tests and skip integration tests: +```bash +buildcli test --skip-integration +``` +This command executes only the unit tests, ignoring any integration tests. + +### Example 3: Run Tests with a Specific Profile +To run tests using a specific profile: + +```bash +buildcli test --profile testing +``` +This command executes the tests with the settings defined in the `testing` profile. + +### Example 4: Generate a Test Report +To generate a report after running the tests: + +```bash +buildcli test --report +``` +This command runs the tests and produces a detailed report of the results. + +### Troubleshooting +If you encounter issues while running tests: + +* Ensure that your project is correctly configured with the necessary test frameworks. +* Check for any errors in the test output for guidance on what went wrong. +* Refer to the help for the test command using `buildcli test --help` for more information. + +### See Also +- [build](build.md) +- [run](run.md) +- [project](project.md) \ No newline at end of file diff --git a/src/commands/version.md b/src/commands/version.md index 51af593..c08c291 100644 --- a/src/commands/version.md +++ b/src/commands/version.md @@ -1,14 +1,16 @@ # `version` -## Description - -Displays the version of BuildCLI. +## Table of Contents +- [Description](#description) +- [Usage](#usage) +- [Options](#options) +- [Examples](#examples) +- [Troubleshooting](#troubleshooting) +- [See Also](#see-also) -## Usage +## Description -```bash -buildcli version -``` +Displays the current version of BuildCLI. This command is useful for users to verify the installed version of the tool, ensuring compatibility with scripts and features. ## Options @@ -17,17 +19,30 @@ buildcli version | `-h, --help` | Display help information about the command. | | `-V, --version` | Display the version of the command. | -## Examples -### Example 1 -Display the version of BuildCLI. +### Examples +### Example 1: Display Current Version +To display the current version of BuildCLI, run: ```bash buildcli version ``` +### Example 2: Display Verbose Version Information +To get more detailed information about the BuildCLI version, use the verbose option: +```bash +buildcli version -V +``` + +### Troubleshooting +If the version command does not return the expected output: + +* Ensure that BuildCLI is correctly installed and accessible in your system’s PATH. +* Check for any updates or issues reported in the [GitHub repository](https://github.com/BuildCLI/website) for BuildCLI. + ## See Also - [project](project.md) -- [autocomplete](autocomplete.md) \ No newline at end of file +- [autocomplete](autocomplete.md) +- [about](about.md) \ No newline at end of file