BuildCLI

BuildCLI is a command-line interface (CLI) tool for managing and automating common tasks in Java project development. It allows you to create, compile, manage dependencies, and run Java projects directly from the terminal, simplifying the development process.

• Repository: https://github.com/wheslleyrimar/buildcli
• License: MIT

---

Table of Contents

• Features
• Installation
• Usage
• Examples
• Contribution
• License

---

Features

• Initialize Project: Creates the basic structure of directories and files for a Java project.
• Compile Project: Compiles the project source code using Maven.
• Add Dependency: Adds new dependencies to the pom.xml.
• Remove Dependency: Remove dependencies from pom.xml.
• Document Code: [Beta] Generates documentation for a Java file using AI.
• Manage Configuration Profiles: Creates specific configuration files for profiles (application-dev.properties, application-test.properties, etc.).
• Run Project: Starts the project directly from the CLI using Spring Boot.

---

Installation

1. Clone the Repository:

   git clone https://github.com/wheslleyrimar/buildcli.git
   cd buildcli

2. Build and Package the Project:

   mvn package

3. Set up BuildCLI for Global Access:

   • Copy the buildcli file to a directory in your system PATH, such as ~/bin:

     cp target/buildcli ~/bin/buildcli
     chmod +x ~/bin/buildcli

Now BuildCLI is ready to use. Test the buildcli command in the terminal.

---

Usage

Below are the main commands of BuildCLI. For more information about each command, you can run buildcli --help.

Usage: buildcli [OPTIONS]
Options:
  -i, --init                Initializes a new Java project
  -c, --compile             Compiles the Java project
      --add-dependency      Adds a dependency to the pom.xml in the 'groupId:artifactId' or 'groupId:artifactId:version' format
      --rm-dependency       Remove a dependency in 'groupId:artifactId' format
  -p, --profile             Creates a configuration profile (e.g., dev, test)
      --run                 Runs the Java project
  -d, --document-code       [Beta] Generates documentation for a Java file using AI (e.g., `buildcli -d <path-to-file>.java`)
  -h, --help                Shows help
  -V, --version             Shows the version of BuildCLI

---

Examples

1. Initialize a New Project

Creates the basic Java project structure, including src/main/java, pom.xml, and README.md:

buildcli --init

2. Compile the Project

Compiles the Java project using Maven:

buildcli --compile

3. Add a Dependency to pom.xml

Adds a dependency to the project in the groupId:artifactId format. You can also specify a version using the format groupId:artifactId:version. If no version is specified, the dependency will default to the latest version available.

Example Commands:

• To add a dependency with the latest version:

  buildcli --add-dependency org.springframework:spring-core

• To add a dependency with a specified version:

  buildcli --add-dependency org.springframework:spring-core:5.3.21

After executing these commands, the dependency will be appended to your pom.xml file under the <dependencies> section.

4. Create a Configuration Profile

Creates a configuration file with the specified profile, for example, application-dev.properties:

buildcli --profile dev

5. Run the Project

Runs the Java project using Spring Boot:

buildcli --run

6. Generate Documentation for Java Code

Automatically generates inline documentation for a Java file using AI:

buildcli --document-code File.java

This command sends the specified Java file to the local Ollama server, which generates documentation and comments directly within the code. The modified file with documentation will be saved back to the same location.

---

Prerequisites

Local Ollama API

Ensure you have the Ollama server running locally, as the --document-code functionality relies on an AI model accessible via a local API.

• Download Ollama

You can start the Ollama server by running:

ollama run llama3.2

Contribution

Contributions are welcome! Feel free to open Issues and submit Pull Requests.

To contribute:

1. Fork the project.
2. Create a branch for your changes:

   git checkout -b my-feature

3. Commit your changes:

   git commit -m "My new feature"

4. Push to your branch:

   git push origin my-feature

5. Open a Pull Request in the main repository.

---

License

This project is licensed under the MIT License - see the LICENSE file for details.