# pmb-cli

**Repository Path**: pmb51/pmb-cli

## Basic Information

- **Project Name**: pmb-cli
- **Description**: pmb物料管理工具
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-30
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# pmb-cli

[![License][license-img]][license-url]
[![NPM Downloads][downloads-img]][downloads-url]
[![NPM Version][version-img]][version-url]
[![Dependency Status][dependency-img]][dependency-url]
[![devDependency Status][devdependency-img]][devdependency-url]
[![Code Style][style-img]][style-url]

> a scaffolding tool

## Installation

```shell
$ npm install pmb-cli

# or yarn
$ yarn add pmb-cli
```

## Usage

<!-- TODO: Introduction of Usage -->

```javascript
const pmbCli = require('pmb-cli')
const result = pmbCli('w')
// result => 'w@zce.me'
```

## API

<!-- TODO: Introduction of API -->

### pmbCli(input, options?)

#### input

- Type: `string`
- Details: name string

#### options

##### host

- Type: `string`
- Details: host string
- Default: `'zce.me'`

## CLI Usage

<!-- TODO: Introduction of CLI -->

Use npx:

```shell
$ npx pmb-cli <input> [options]
```

Globally install:

```shell
$ npm install pmb-cli -g
# or yarn
$ yarn global add pmb-cli
```

```shell
$ pmb-cli --help
demo v0.1.0

Usage:
  $ pmb-cli <input>

Commands:
  <input>  Sample cli program

For more info, run any command with the `--help` flag:
  $ pmb-cli --help

Options:
  --host <host>  Sample options
  -h, --help     Display this message
  -v, --version  Display version number

Examples:
  $ pmb-cli w --host zce.me
```

## Contributing

1. **Fork** it on GitHub!
2. **Clone** the fork to your own machine.
3. **Checkout** your feature branch: `git checkout -b my-awesome-feature`
4. **Commit** your changes to your own branch: `git commit -am 'Add some feature'`
5. **Push** your work back up to your fork: `git push -u origin my-awesome-feature`
6. Submit a **Pull Request** so that we can review your changes.

> **NOTE**: Be sure to merge the latest from "upstream" before making a pull request!

## License

[MIT](LICENSE) &copy; [windfly](https://windfly.com)



[license-img]: https://img.shields.io/github/license/xiaozhi93/pmb-cli
[license-url]: https://github.com/xiaozhi93/pmb-cli/blob/master/LICENSE
[downloads-img]: https://img.shields.io/npm/dm/pmb-cli
[downloads-url]: https://npmjs.org/package/pmb-cli
[version-img]: https://img.shields.io/npm/v/pmb-cli
[version-url]: https://npmjs.org/package/pmb-cli
[dependency-img]: https://img.shields.io/david/xiaozhi93/pmb-cli
[dependency-url]: https://david-dm.org/xiaozhi93/pmb-cli
[devdependency-img]: https://img.shields.io/david/dev/xiaozhi93/pmb-cli
[devdependency-url]: https://david-dm.org/xiaozhi93/pmb-cli?type=dev
[style-img]: https://img.shields.io/badge/code_style-standard-brightgreen
[style-url]: https://standardjs.com