# cmd-man

**Repository Path**: ahviplc/cmd-man

## Basic Information

- **Project Name**: cmd-man
- **Description**: cmd-man,一款基于nodejs的专属于你的命令行工具.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-20
- **Last Updated**: 2021-06-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center">Welcome to cmd-man 👋</h1>
<p>
  <img alt="Version" src="https://img.shields.io/badge/version-1.0.0-blue.svg?cacheSeconds=2592000" />
  <a href="#" target="_blank">
    <img alt="License: ISC" src="https://img.shields.io/badge/License-ISC-yellow.svg" />
  </a>
</p>

> cmd-man,一款基于nodejs的专属于你的命令行工具.

`cmd-man,采用的commonjs模块规范`

也可package.json配置`"type":"module",` 使用esm规范. 默认为`"type": "commonjs",`

### 🏠 [npm | ahviplc](https://www.npmjs.com/~ahviplc)

### 🏠 [npm | cmd-man](https://www.npmjs.com/package/cmd-man)

### 🏠 [Homepage-gitee](https://gitee.com/ahviplc/cmd-man)

### ✨ [Demo-gitee](https://gitee.com/ahviplc/cmd-man)

### 🏠 [Homepage-github](https://github.com/ahviplc/cmd-man)

### ✨ [Demo-github](https://github.com/ahviplc/cmd-man)

## cmd-man npm api

`可以查看此npm模块的信息json串`

> http://registry.npmjs.org/cmd-man

## Prerequisites

- node >12.0.0

## Install

```sh
yarn (最好使用yarn 感觉使用npm有些依赖会缺失)
yarn install
或者
npm i
npm install
```

## npm或yarn全局安装与使用

`全局npm安装或yarn安装`

```sh
npm i -g cmd-man
或者
npm install -g cmd-man
或者
yarn add global cmd-man
```

`注意yarn全局目录的bin要在加入环境变量,使用此命令,才可以被找到.`

`全局命令使用` `使用下面命令`

```sh
cmd-man
或者
cm
```

## Usage

`针对的是你使用源码的方式 安装好依赖 执行`

`其他情况 最好从npm全局安装 使用全局命令直接执行`

```sh
yarn app
或者
yarn app -a
或者
npm run app (不可用)
或者
node ./bin/index.js
或者
node ./bin/index.js -a
```

## Run tests

`TODO`

```sh
yarn run test
或者
jest
```

`Done`

```sh
npm run app-test
或
yarn run app-test
```

## Links

```markdown
https://github.com/tj/commander.js

https://codechina.csdn.net/mirrors/tj/commander.js

https://github.com/eslint/eslint

https://eslint.org/

http://eslint.cn/

http://eslint.cn/docs/rules/

https://github.com/feross/standard

https://github.com/standard/standard

https://hub.fastgit.org/standard/standard

https://hub.fastgit.org/standard/standard/blob/master/docs/RULES-zhcn.md

https://github1s.com/FrendEr/show-man/blob/HEAD/bin/show.js

https://www.npmjs.com/package/chalk

https://github.com/chalk/chalk

Node.js 中文网
http://nodejs.cn/

API 文档 - Node.js 中文网
http://api.nodejs.cn/
```

## Author

👤 **LC ahlc@sina.cn**

* Website:  https://gitee.com/ahviplc/cmd-man
* Github: [@ahviplc](https://github.com/ahviplc)

## Show your support

Give a ⭐️ if this project helped you!

***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_