spring-boot-cli/README.md

CLI for Spring Boot

# Spring Boot CLI

<span class="badge-npmversion">
    <a href="https://www.npmjs.com/package/spring-boot-cli" title="View this project on NPM" target="_blank">
        <img src="https://img.shields.io/npm/v/spring-boot-cli" alt="NPM version"/>
    </a>
</span>
<span class="badge-githublastcommit">
    <img style="pointer-events: none" src="https://img.shields.io/github/last-commit/theapplegeek/spring-boot-cli" alt="GitHub last commit">
</span>
<span class="badge-buymeacoffee">
    <a href="https://www.buymeacoffee.com/weibin.xu" title="Buy me a coffee" target="_blank">
        <img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 20px !important;width: 72px !important;"/>
    </a>
</span>

## Introduction

An CLI application that can be used to create a Spring Boot project with a starter template.

## Template

The template is a simple Spring Boot project with a same utility classes and authentication.

For more information, please refer to the [template project](https://github.com/theapplegeek/Spring-Boot-Starter.git).

## Usage

To create a new project, run the following command:

```shell
npx spring-boot-cli create <project-name>
```

## Installation

You can also install the CLI globally:

```shell
npm install -g spring-boot-cli
```

Then you can run the following command:

```shell
spring-boot-cli create <project-name>
```

Note: You can also use `sc` as an alias for `spring-boot-cli`.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE.md) file for details.