# TCLI

**Repository Path**: QQXQQ/TCLI

## Basic Information

- **Project Name**: TCLI
- **Description**: 模板脚手架
- **Primary Language**: NodeJS
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-08-06
- **Last Updated**: 2026-02-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# TCLI

TCLI 是一个用于快速创建项目模板的脚手架工具（模板脚手架）。通过交互式命令行界面，帮助开发者快速从远程模板仓库下载并创建新项目。

## 功能特性

- 🎯 **交互式创建** - 采用 Inquirer 提供友好的命令行交互体验
- 📦 **模板管理** - 支持从远程仓库获取模板列表和版本标签
- ⏳ **加载提示** - 使用 Ora 显示优雅的加载动画
- 🔄 **自动下载** - 自动下载并解压模板到指定目录

## 技术栈

- **Node.js** - JavaScript 运行时
- **Inquirer** - 命令行交互工具
- **Axios** - HTTP 请求库
- **Ora** - 终端加载动画
- **Download** - 文件下载工具

## 目录结构

```
TCLI/
├── bin/
│   └── tcli              # 入口文件
├── lib/
│   ├── Creator.js        # 创建器核心类
│   ├── config.js         # 配置文件
│   ├── create.js         # 创建命令实现
│   ├── download.js       # 下载模块
│   ├── request.js        # API 请求模块
│   ├── ui.js             # UI 组件
│   └── util.js           # 工具函数
└── package.json          # 项目配置
```

## 安装教程

### 环境要求

- Node.js >= 12.0.0
- npm >= 6.0.0

### 安装步骤

```bash
# 克隆项目
git clone https://gitee.com/QQXQQ/TCLI.git

# 进入项目目录
cd TCLI

# 安装依赖
npm install

# 全局链接（可选）
npm link
```

## 使用说明

### 基本用法

```bash
# 运行 TCLI
node bin/tcli

# 或全局安装后
tcli
```

### 操作流程

1. 运行命令后，系统会从远程获取模板仓库列表
2. 选择需要使用的模板仓库
3. 选择模板版本标签
4. 输入项目名称
5. 等待模板下载完成

## 核心模块说明

### Creator.js

模板创建器核心类，负责：
- `fetchRepo()` - 获取远程模板仓库列表
- `fetchTag(repo)` - 获取指定仓库的版本标签
- `downloadTemplate(repo, tag)` - 下载模板到本地
- `create()` - 执行完整的创建流程

### request.js

封装了 Axios，提供模板仓库和标签的 API 请求功能。

### util.js

工具函数模块：
- `wrapLoading()` - 包装异步函数并显示加载动画
- `sleep()` - 延迟函数

## 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

## 开源协议

本项目仅供学习参考使用。