README.md · Lauset/vuetom-cli

# Vuetom CLI

> Blog & Documents generation tool

Version: 0.2.x

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

[CHANGELOG](./CHANGELOG.md)

## Links

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

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

## Install

**npm**

```bash
npm install vuetom-cli -g

# options: show version
vuetom-cli -v

# options: show help information
vuetom-cli --help
```

**yarn**

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

## Usage

**Options**

`-v, --vers`: View the current version number

`-h, --help`: View the current help

**Commands**

`init`: Initialize a project with a vuetom theme

`list`: Show the latest information about the vuetom cli branch

`git`: Show the link of user's GIT warehouse list

`ver`: Show theme or templates local version number

`help`: Same as -h option

`-l`: Change language

**eg.**

```bash
# Show Version
vuetom-cli -v

# Show HelpInformation
vuetom-cli -h

# Create docs templates
vuetom-cli init

# See the latest submission
vuetom-cli list
vuetom-cli list temp-docs

# Show someone's repo
vuetom-cli git lauset
vuetom-cli git lauset gitee

# Show local template version
vuetom-cli ver
vuetom-cli ver -t docs

# Change language to zh 
vuetom-cli -l zh
vuetom-cli -l en # english
vuetom-cli -l    # show language

# Auto check update
vuetom-cli -u # manual operation command
vuetom-cli -u 0.2.7 # update to new version
```

## development

```bash
# install 
pnpm install

# Compiling TS files
pnpm build

# Test Cli (dev)
pnpm ts
pnpm ts:init
pnpm ts:list

# Test Cli (prod)
pnpm cli
pnpm cli:init
pnpm cli:list

# check dependencies updates
ncu

# update all dependencies
ncu -u
```

## ShowTime

`% vuetom-cli`

<img width="" src="media/vt01.png" alt="vt01"/>

`% vuetom-cli init`

<img width="" src="media/vt02.png" alt="vt02"/>

`% vuetom-cli list`

<img width="" src="media/vt03.png" alt="vt03"/>

`% vuetom-cli git`

<img width="" src="media/vt04.png" alt="vt04"/>

`$ vuetom-cli ver`

<img width="" src="media/vt05.png" alt="vt05"/>

`$ vuetom-cli -u`

<img width="" src="media/vt06.png" alt="vt06"/>

Lauset/vuetom-cli

简介

发行版 (1)

贡献者

近期动态

Lauset/vuetom-cli .gitee-modal { width: 500px !important; }

简介

发行版 (1)

贡献者

近期动态

搜索帮助

Lauset/vuetom-cli