UNPKG

2.72 kBMarkdownView Raw
1@oclif/example-multi-ts
2=======================
3
4example multi-command CLI built with typescript
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-multi-ts.svg)](https://npmjs.org/package/@oclif/example-multi-ts)
8[![CircleCI](https://circleci.com/gh/oclif/example-multi-ts/tree/master.svg?style=shield)](https://circleci.com/gh/oclif/example-multi-ts/tree/master)
9[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/example-multi-ts?branch=master&svg=true)](https://ci.appveyor.com/project/oclif/example-multi-ts/branch/master)
10[![Codecov](https://codecov.io/gh/oclif/example-multi-ts/branch/master/graph/badge.svg)](https://codecov.io/gh/oclif/example-multi-ts)
11[![Downloads/week](https://img.shields.io/npm/dw/@oclif/example-multi-ts.svg)](https://npmjs.org/package/@oclif/example-multi-ts)
12[![License](https://img.shields.io/npm/l/@oclif/example-multi-ts.svg)](https://github.com/oclif/example-multi-ts/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-multi-ts
22$ example-multi-ts COMMAND
23running command...
24$ example-multi-ts (-v|--version|version)
25@oclif/example-multi-ts/1.8.0 linux-x64 node-v10.3.0
26$ example-multi-ts --help [COMMAND]
27USAGE
28 $ example-multi-ts COMMAND
29...
30```
31<!-- usagestop -->
32# Commands
33<!-- commands -->
34* [`example-multi-ts goodbye [FILE]`](#example-multi-ts-goodbye-file)
35* [`example-multi-ts hello [FILE]`](#example-multi-ts-hello-file)
36* [`example-multi-ts help [COMMAND]`](#example-multi-ts-help-command)
37
38## `example-multi-ts goodbye [FILE]`
39
40describe the command here
41
42```
43USAGE
44 $ example-multi-ts goodbye [FILE]
45
46OPTIONS
47 -f, --force
48 -h, --help show CLI help
49 -n, --name=name name to print
50```
51
52_See code: [src/commands/goodbye.ts](https://github.com/oclif/example-multi-ts/blob/v1.8.0/src/commands/goodbye.ts)_
53
54## `example-multi-ts hello [FILE]`
55
56describe the command here
57
58```
59USAGE
60 $ example-multi-ts hello [FILE]
61
62OPTIONS
63 -f, --force
64 -h, --help show CLI help
65 -n, --name=name name to print
66
67EXAMPLE
68 $ example-multi-ts hello
69 hello world from ./src/hello.ts!
70```
71
72_See code: [src/commands/hello.ts](https://github.com/oclif/example-multi-ts/blob/v1.8.0/src/commands/hello.ts)_
73
74## `example-multi-ts help [COMMAND]`
75
76display help for example-multi-ts
77
78```
79USAGE
80 $ example-multi-ts help [COMMAND]
81
82ARGUMENTS
83 COMMAND command to show help for
84
85OPTIONS
86 --all see all commands in CLI
87```
88
89_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.0.4/src/commands/help.ts)_
90<!-- commandsstop -->