# vuetom-cli

**Repository Path**: lauset/vuetom-cli

## Basic Information

- **Project Name**: vuetom-cli
- **Description**: 一款为 Vuetom 主题而生的脚手架，可快速克隆项目，支持远程仓库信息访问、多语言切换
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://github.com/lauset/vuetom-cli
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2022-01-07
- **Last Updated**: 2022-12-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Cli, Vuetom

## README

# Vuetom CLI

<h1 align="center">
 <br>
 <img width="320" src="media/vuetom-logo-m.png" alt="vuetom-cli">
 <br>
</h1>

> 快速生成 `文档` 与 `博客` 主题项目

版本: 0.2.x

[English](./README.md) | 中文

[更新日志](./CHANGELOG.md)

## 链接

[npm](https://www.npmjs.com/package/vuetom-cli)

[github](https://github.com/lauset/vuetom-cli)

## 安装

**使用 npm**

```bash
npm install vuetom-cli -g

# 选项: 打印版本号
vuetom-cli -v

# 选项: 打印帮助信息
vuetom-cli --help
```

**使用 yarn**

```bash
yarn global add vuetom-cli
```

## 使用

**选项**

`-v, --vers`: 打印当前 Cli 版本号

`-h, --help`: 显示帮助信息

**命令**

`init`: 初始化一个带有 vuetom 主题的 vitepress 项目

`list`: 展示 cli 各个分支的最新提交信息

`git`: 展示某用户的 Github 或 Gitee 仓库列表链接

`ver`: 展示文档与博客模版的线上版本号

`help`: 用法同 -h

`-l`: 展示并修改语言

**举例：**

```bash
# 输出版本号
vuetom-cli -v

# 输出帮助信息
vuetom-cli -h

# 初始化带有主题的项目
vuetom-cli init

# 查看 temp-docs 分支的最新提交信息
vuetom-cli list
vuetom-cli list temp-docs

# 查看 lauset 的 gitee 仓库列表
vuetom-cli git lauset
vuetom-cli git lauset gitee

# 查看 docs 模版的线上版本号
vuetom-cli ver
vuetom-cli ver -t docs

# 改变命令行语言
vuetom-cli -l zh
vuetom-cli -l en # 切换至指定语言(en、zh、zhTW)
vuetom-cli -l    # 列出所有可用语言

# 自动检查CLI版本
vuetom-cli -u # 手动检查更新
vuetom-cli -u 0.2.7 # 更新至指定版本
```

## 开发流程

```bash
# 安装依赖 
pnpm install

# 编译 TS 文件
pnpm build

# 测试 Cli (开发)
pnpm ts
pnpm ts:init
pnpm ts:list

# 测试 Cli (正式)
pnpm cli
pnpm cli:init
pnpm cli:list

# 检查依赖最新的版本号
ncu

# 更新依赖版本号
ncu -u
```

## 来吧展示

`% vuetom-cli`

<!-- ![vc01](./media/vt01.png) -->
<img width="" src="media/vt01.png" alt="vt01"/>

`% vuetom-cli init`

<!-- ![vc02](./media/vt02.png) -->
<img width="" src="media/vt02.png" alt="vt02"/>

`% vuetom-cli list`

<!-- ![vc03](./media/vt03.png) -->
<img width="" src="media/vt03.png" alt="vt03"/>

`% vuetom-cli git`

<!-- ![vc04](./media/vt04.png) -->
<img width="" src="media/vt04.png" alt="vt04"/>

`$ vuetom-cli ver`

<!-- ![vc05](./media/vt05.png) -->
<img width="" src="media/vt05.png" alt="vt05"/>

`$ vuetom-cli -u`

<!-- ![vc06](./media/vt06.png) -->
<img width="" src="media/vt06.png" alt="vt06"/>