1 | @oclif/dev-cli
|
2 | ===============
|
3 |
|
4 | helpers for oclif CLIs
|
5 |
|
6 | [![Version](https://img.shields.io/npm/v/@oclif/dev-cli.svg)](https://npmjs.org/package/@oclif/dev-cli)
|
7 | [![CircleCI](https://circleci.com/gh/oclif/dev-cli/tree/master.svg?style=shield)](https://circleci.com/gh/oclif/dev-cli/tree/master)
|
8 | [![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/dev-cli?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/dev-cli/branch/master)
|
9 | [![Known Vulnerabilities](https://snyk.io/test/npm/@oclif/dev-cli/badge.svg)](https://snyk.io/test/npm/@oclif/dev-cli)
|
10 | [![Downloads/week](https://img.shields.io/npm/dw/@oclif/dev-cli.svg)](https://npmjs.org/package/@oclif/dev-cli)
|
11 | [![License](https://img.shields.io/npm/l/@oclif/dev-cli.svg)](https://github.com/oclif/dev-cli/blob/master/package.json)
|
12 |
|
13 |
|
14 | * [Usage](#usage)
|
15 | * [Commands](#commands)
|
16 |
|
17 | # Usage
|
18 |
|
19 | ```sh-session
|
20 | $ npm install -g @oclif/dev-cli
|
21 | $ oclif-dev COMMAND
|
22 | running command...
|
23 | $ oclif-dev (-v|--version|version)
|
24 | @oclif/dev-cli/1.26.3 linux-x64 node-v14.18.1
|
25 | $ oclif-dev --help [COMMAND]
|
26 | USAGE
|
27 | $ oclif-dev COMMAND
|
28 | ...
|
29 | ```
|
30 |
|
31 | # Commands
|
32 |
|
33 | * [`oclif-dev help [COMMAND]`](#oclif-dev-help-command)
|
34 | * [`oclif-dev manifest [PATH]`](#oclif-dev-manifest-path)
|
35 | * [`oclif-dev pack`](#oclif-dev-pack)
|
36 | * [`oclif-dev pack:deb`](#oclif-dev-packdeb)
|
37 | * [`oclif-dev pack:macos`](#oclif-dev-packmacos)
|
38 | * [`oclif-dev pack:win`](#oclif-dev-packwin)
|
39 | * [`oclif-dev publish`](#oclif-dev-publish)
|
40 | * [`oclif-dev publish:deb`](#oclif-dev-publishdeb)
|
41 | * [`oclif-dev publish:macos`](#oclif-dev-publishmacos)
|
42 | * [`oclif-dev publish:win`](#oclif-dev-publishwin)
|
43 | * [`oclif-dev readme`](#oclif-dev-readme)
|
44 |
|
45 | ## `oclif-dev help [COMMAND]`
|
46 |
|
47 | display help for oclif-dev
|
48 |
|
49 | ```
|
50 | USAGE
|
51 | $ oclif-dev help [COMMAND]
|
52 |
|
53 | ARGUMENTS
|
54 | COMMAND command to show help for
|
55 |
|
56 | OPTIONS
|
57 | --all see all commands in CLI
|
58 | ```
|
59 |
|
60 | _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v3.2.7/src/commands/help.ts)_
|
61 |
|
62 | ## `oclif-dev manifest [PATH]`
|
63 |
|
64 | generates plugin manifest json
|
65 |
|
66 | ```
|
67 | USAGE
|
68 | $ oclif-dev manifest [PATH]
|
69 |
|
70 | ARGUMENTS
|
71 | PATH [default: .] path to plugin
|
72 | ```
|
73 |
|
74 | _See code: [src/commands/manifest.ts](https://github.com/oclif/dev-cli/blob/v1.26.3/src/commands/manifest.ts)_
|
75 |
|
76 | ## `oclif-dev pack`
|
77 |
|
78 | packages oclif cli into tarballs
|
79 |
|
80 | ```
|
81 | USAGE
|
82 | $ oclif-dev pack
|
83 |
|
84 | OPTIONS
|
85 | -r, --root=root (required) [default: .] path to oclif CLI root
|
86 | -t, --targets=targets comma-separated targets to pack (e.g.: linux-arm,win32-x64)
|
87 | --[no-]xz also build xz
|
88 |
|
89 | DESCRIPTION
|
90 | This can be used to create oclif CLIs that use the system node or that come preloaded with a node binary.
|
91 | ```
|
92 |
|
93 | _See code: [src/commands/pack/index.ts](https://github.com/oclif/dev-cli/blob/v1.26.3/src/commands/pack/index.ts)_
|
94 |
|
95 | ## `oclif-dev pack:deb`
|
96 |
|
97 | pack CLI into debian package
|
98 |
|
99 | ```
|
100 | USAGE
|
101 | $ oclif-dev pack:deb
|
102 |
|
103 | OPTIONS
|
104 | -r, --root=root (required) [default: .] path to oclif CLI root
|
105 | ```
|
106 |
|
107 | _See code: [src/commands/pack/deb.ts](https://github.com/oclif/dev-cli/blob/v1.26.3/src/commands/pack/deb.ts)_
|
108 |
|
109 | ## `oclif-dev pack:macos`
|
110 |
|
111 | pack CLI into MacOS .pkg
|
112 |
|
113 | ```
|
114 | USAGE
|
115 | $ oclif-dev pack:macos
|
116 |
|
117 | OPTIONS
|
118 | -r, --root=root (required) [default: .] path to oclif CLI root
|
119 | ```
|
120 |
|
121 | _See code: [src/commands/pack/macos.ts](https://github.com/oclif/dev-cli/blob/v1.26.3/src/commands/pack/macos.ts)_
|
122 |
|
123 | ## `oclif-dev pack:win`
|
124 |
|
125 | create windows installer from oclif CLI
|
126 |
|
127 | ```
|
128 | USAGE
|
129 | $ oclif-dev pack:win
|
130 |
|
131 | OPTIONS
|
132 | -r, --root=root (required) [default: .] path to oclif CLI root
|
133 | ```
|
134 |
|
135 | _See code: [src/commands/pack/win.ts](https://github.com/oclif/dev-cli/blob/v1.26.3/src/commands/pack/win.ts)_
|
136 |
|
137 | ## `oclif-dev publish`
|
138 |
|
139 | publish an oclif CLI to S3
|
140 |
|
141 | ```
|
142 | USAGE
|
143 | $ oclif-dev publish
|
144 |
|
145 | OPTIONS
|
146 | -r, --root=root (required) [default: .] path to oclif CLI root
|
147 | -t, --targets=targets comma-separated targets to pack (e.g.: linux-arm,win32-x64)
|
148 |
|
149 | DESCRIPTION
|
150 | "aws-sdk" will need to be installed as a devDependency to publish.
|
151 | ```
|
152 |
|
153 | _See code: [src/commands/publish/index.ts](https://github.com/oclif/dev-cli/blob/v1.26.3/src/commands/publish/index.ts)_
|
154 |
|
155 | ## `oclif-dev publish:deb`
|
156 |
|
157 | publish deb package built with pack:deb
|
158 |
|
159 | ```
|
160 | USAGE
|
161 | $ oclif-dev publish:deb
|
162 |
|
163 | OPTIONS
|
164 | -r, --root=root (required) [default: .] path to oclif CLI root
|
165 | ```
|
166 |
|
167 | _See code: [src/commands/publish/deb.ts](https://github.com/oclif/dev-cli/blob/v1.26.3/src/commands/publish/deb.ts)_
|
168 |
|
169 | ## `oclif-dev publish:macos`
|
170 |
|
171 | publish macos installers built with pack:macos
|
172 |
|
173 | ```
|
174 | USAGE
|
175 | $ oclif-dev publish:macos
|
176 |
|
177 | OPTIONS
|
178 | -r, --root=root (required) [default: .] path to oclif CLI root
|
179 | ```
|
180 |
|
181 | _See code: [src/commands/publish/macos.ts](https://github.com/oclif/dev-cli/blob/v1.26.3/src/commands/publish/macos.ts)_
|
182 |
|
183 | ## `oclif-dev publish:win`
|
184 |
|
185 | publish windows installers built with pack:win
|
186 |
|
187 | ```
|
188 | USAGE
|
189 | $ oclif-dev publish:win
|
190 |
|
191 | OPTIONS
|
192 | -r, --root=root (required) [default: .] path to oclif CLI root
|
193 | ```
|
194 |
|
195 | _See code: [src/commands/publish/win.ts](https://github.com/oclif/dev-cli/blob/v1.26.3/src/commands/publish/win.ts)_
|
196 |
|
197 | ## `oclif-dev readme`
|
198 |
|
199 | adds commands to README.md in current directory
|
200 |
|
201 | ```
|
202 | USAGE
|
203 | $ oclif-dev readme
|
204 |
|
205 | OPTIONS
|
206 | --dir=dir (required) [default: docs] output directory for multi docs
|
207 | --multi create a different markdown page for each topic
|
208 |
|
209 | DESCRIPTION
|
210 | The readme must have any of the following tags inside of it for it to be replaced or else it will do nothing:
|
211 | # Usage
|
212 | <!-- usage -->
|
213 | # Commands
|
214 | <!-- commands -->
|
215 |
|
216 | Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
|
217 | ```
|
218 |
|
219 | _See code: [src/commands/readme.ts](https://github.com/oclif/dev-cli/blob/v1.26.3/src/commands/readme.ts)_
|
220 |
|