# smartCli

**Repository Path**: alisonyu/smartCli

## Basic Information

- **Project Name**: smartCli
- **Description**: 快速开发命令行程序
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2018-02-24
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

### SmartCli
SmartCli是一个快速开发命令行（CLI）程序的轻量级框架，只需要简单的配置就可以实现一个命令行程序。

#### Get Start
首先定义自己的业务逻辑，@Cli修饰该类，该类下的所有被@Command修饰的方法将会被扫描，利用@Usage可以添加方法的说明
```java
package example;
import com.alison.SmartCli.*;
@Cli
public class Controller {

    @Command
    @Usage("a simple function to add a and b")
    public int add(int a,int b){
        return a+b;
    }

    @Command
    @Usage("simple echo function")
    public String echo(String s){
        return s;
    }

}

```
启动命令行
```java
import com.alison.SmartCli.SmartCli;
public class App {
    public static void main(String[] args) throws Exception {
        SmartCli smartCli = new SmartCli();
        smartCli.setDebug(false);
        smartCli.scanPackage("example");
        smartCli.handle(args);
    }
}
```
你可以Java程序打包成Jar包，或者直接运行.class程序，然后运行
```
$ java -jar $Jar_File_Name echo helloCli
helloCli
$ java -jar $Jar_File_Name add 1 2
3
```
SmartCli里面内置了一些函数，例如usage是查看某个函数的用法
```
$ java -jar $Jar_File_Name usage add
add : a simple function to add a and b
```