UNPKG

1.83 kBMarkdownView Raw
1@oclif/example-plugin-js
2========================
3
4example dxcli plugin in javascript
5
6[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
7[![Version](https://img.shields.io/npm/v/@oclif/example-plugin-js.svg)](https://npmjs.org/package/@oclif/example-plugin-js)
8[![CircleCI](https://circleci.com/gh/oclif/example-plugin-js/tree/master.svg?style=shield)](https://circleci.com/gh/oclif/example-plugin-js/tree/master)
9[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/example-plugin-js?branch=master&svg=true)](https://ci.appveyor.com/project/oclif/example-plugin-js/branch/master)
10[![Codecov](https://codecov.io/gh/oclif/example-plugin-js/branch/master/graph/badge.svg)](https://codecov.io/gh/oclif/example-plugin-js)
11[![Downloads/week](https://img.shields.io/npm/dw/@oclif/example-plugin-js.svg)](https://npmjs.org/package/@oclif/example-plugin-js)
12[![License](https://img.shields.io/npm/l/@oclif/example-plugin-js.svg)](https://github.com/oclif/example-plugin-js/blob/master/package.json)
13
14<!-- toc -->
15* [Usage](#usage)
16* [Commands](#commands)
17<!-- tocstop -->
18# Usage
19<!-- usage -->
20```sh-session
21$ npm install -g @oclif/example-plugin-js
22$ oclif-example COMMAND
23running command...
24$ oclif-example (-v|--version|version)
25@oclif/example-plugin-js/1.10.0 linux-x64 node-v10.9.0
26$ oclif-example --help [COMMAND]
27USAGE
28 $ oclif-example COMMAND
29...
30```
31<!-- usagestop -->
32# Commands
33<!-- commands -->
34* [`oclif-example hello`](#oclif-example-hello)
35
36## `oclif-example hello`
37
38Describe the command here
39
40```
41USAGE
42 $ oclif-example hello
43
44OPTIONS
45 -n, --name=name name to print
46
47DESCRIPTION
48 ...
49 Extra documentation goes here
50```
51
52_See code: [src/commands/hello.js](https://github.com/oclif/example-plugin-js/blob/v1.10.0/src/commands/hello.js)_
53<!-- commandsstop -->