# colin-cli

**Repository Path**: colincck/colin-cli

## Basic Information

- **Project Name**: colin-cli
- **Description**: mycli，快速搭建vue2项目
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-02-22
- **Last Updated**: 2023-10-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# colin-cli
[![npm](https://badge.fury.io/js/colin-cli.svg)](https://www.npmjs.com/package/colin-cli)

colin-cli 一个帮助你快速搭建和开发以及管理前端项目的 CLI


## 版本历史
### 2.2.9 (2023/10/29)
- 完成 actions 目录文件的重构
- 完成 cl run 的设置远程仓库地址功能
- 完善 cl setrepo 命令，可以通过-f来添加没有的框架远程仓库地址
- 引入 ora 动画库，实现等待动画效果，提升用户体验

... ...

### 2.2.6 (2023/10/23)

- 修复 npm run 命令在新项目找不到路径问题

### 2.2.0 - 2.2.1 (2023/10/22)

- 新增 cl run 命令，提供命令行交互功能
- 实现 命令（Vue拉取项目模板、git提交限制部署）、设置、帮助、切换语言功能

### 2.1.12 (2023/10/21)

- 规范项目代码（引入 module-alias 管理项目别名）

### 2.1.11 (2023/10/20)

- 修复 cl create 命令拉取Vue项目在安装依赖时提前打开浏览器问题

### 2.1.10 (2023/10/20)

- 规范log函数输出，统一使用CONSTANT进行管理

### 2.1.9 (2023/10/19)

- 修复.cz-config文件自定义type不支持问题

### 2.1.8 (2023/10/18)

- 修复 git cz 命令提交类型文本未对齐问题

### 2.1.7 (2023/10/14)

- 强制覆盖本地commitizen，避免版本不一致问题

### 2.1.6 (2023/10/13)

- git cz 提交命令添加 update 类型

### 2.1.4 (2023/10/2)

- 修复写入 czConfig 文件中文乱码问题


## [文档](#documentation)
<a name="documentation"></a>

## 安装 
<a name="installation"></a>

```shell
npm install colin-cli -g
```


## 使用 

#### 给项目添加git提交限制
**依赖库** 是 [commitlint] + [husky] + [commitizen] 来限制项目的git msg提交
```shell
cl gitlimit

执行完上边命令后，则可以通过 git cz 或 npm run commit 来代替 git commit 了！
```

#### 使用命令行交互功能
```shell
cl run
```

#### 创建项目

```shell
cl create <project>
```


#### 创建一个新组件

```shell
cl addcpn <copmonent> [-d <dest>]
```

#### 修改安装模板地址

```shell
cl setrepo <registry>
```

#### 查看所有模板地址

```shell
cl showrepo
```