# torna-cli

**Repository Path**: durcframework/torna-cli

## Basic Information

- **Project Name**: torna-cli
- **Description**: Torna CLI 命令行工具，用于将 Java Spring MVC 项目的 API 文档推送到Torna平台。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2026-01-25
- **Last Updated**: 2026-02-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Torna CLI

Torna CLI 是一个命令行工具，用于将 Java Spring MVC 项目的 API 文档推送到 [Torna](https://torna.cn/) 平台。

## 功能特性

- 自动扫描 Spring MVC 源代码
- 推送 API 文档到 Torna 平台
- 支持多个源代码目录
- 灵活的配置文件支持

## 环境要求

- Java 8 或更高版本
- Maven 3.x

## 使用说明

前往[发行版页面](https://gitee.com/durcframework/torna-cli/releases)下载最新版本

解压zip，使用jar推送文档

格式：

```bash
java -jar torna-cli-0.1.0.jar push -c <配置文件> -s <源码目录>
```

如：`java -jar torna-cli-0.1.0.jar push -c torna.yml -s /Users/xxx/IdeaProjects/project-name`

- 不依赖配置文件推送

```shell
java -Dfile.encoding=UTF-8 -jar torna-cli-0.1.4.jar push \
-u http://localhost:7700/api \
-t 8773b33f65b54f04806118eed1774ee1 \
-s /Users/thc/Projects/torna-example/torna-and-smart-doc \
-f "class:cn.torna.example.web.controller.product.CategoryController" \
-a jim1 \
-d 
```

### 参数说明

| 参数           | 简写 | 说明 | 是否必填 |
|--------------|----|------|------|
| --src        | -s | 源代码目录，多个目录用逗号分隔 | 是    |
| --configFile | -c | 配置文件名称或路径 | 否    |
| --url        | -u | Torna 平台地址 | 否    |
| --token      | -t | Torna 平台 token | 否    |
| --author     | -a | 作者名称 | 否    |
| --debug      | -d | 调试模式 | 否    |
| --help       | -h | 显示帮助信息 | 否    |
| --version    | -V | 显示版本信息 | 否    |
| --file       | -f | 配置文件内容 | 否    |


### 配置文件说明

配置文件（如 `torna.yml`）需要放置在项目的 `resources` 目录下

### 配置文件查找规则

1. 如果 `-c` 指定的路径存在文件，直接使用该文件
2. 如果 `-c` 指定的是文件名（非完整路径），会在源代码目录的 `resources` 目录下查找该文件

## 开发

### 项目结构

```
torna-cli/
├── pom.xml
└── src/
    └── main/
        └── java/
            └── cn/
                └── torna/
                    └── cli/
                        ├── Cli.java          # 主入口类
                        └── PushCommand.java  # 推送命令实现
```

### 构建

运行命令：

```bash
mvn clean package
```

构建完成后，会在 `target` 目录下生成 `torna-cli-0.1.0.jar` 文件。


### 依赖说明

- **torna-plugin**: Torna 插件核心库 (0.1.4)
- **picocli**: 命令行参数解析库 (4.7.5)
- **lombok**: Java 简化工具库 (1.18.34)

## 许可证

本项目遵循相应的开源许可证。

## 相关链接

- [Torna 官网](https://torna.cn/)