Package Exports
- @oclif/dev-cli
- @oclif/dev-cli/lib/commands/readme
- @oclif/dev-cli/lib/commands/readme.js
- @oclif/dev-cli/lib/index.js
- @oclif/dev-cli/lib/log
- @oclif/dev-cli/lib/log.js
- @oclif/dev-cli/lib/tarballs
- @oclif/dev-cli/lib/tarballs/index.js
- @oclif/dev-cli/lib/util
- @oclif/dev-cli/lib/util.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@oclif/dev-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@oclif/dev-cli
helpers for oclif CLIs
Usage
$ npm install -g @oclif/dev-cli
$ oclif-dev COMMAND
running command...
$ oclif-dev (-v|--version|version)
@oclif/dev-cli/1.26.10 linux-x64 node-v14.18.2
$ oclif-dev --help [COMMAND]
USAGE
$ oclif-dev COMMAND
...Commands
oclif-dev help [COMMAND]oclif-dev manifest [PATH]oclif-dev packoclif-dev pack:deboclif-dev pack:macosoclif-dev pack:winoclif-dev publishoclif-dev publish:deboclif-dev publish:macosoclif-dev publish:winoclif-dev readme
oclif-dev help [COMMAND]
display help for oclif-dev
USAGE
$ oclif-dev help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLISee code: @oclif/plugin-help
oclif-dev manifest [PATH]
generates plugin manifest json
USAGE
$ oclif-dev manifest [PATH]
ARGUMENTS
PATH [default: .] path to pluginSee code: src/commands/manifest.ts
oclif-dev pack
packages oclif cli into tarballs
USAGE
$ oclif-dev pack
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
-t, --targets=targets comma-separated targets to pack (e.g.: linux-arm,win32-x64)
--[no-]xz also build xz
DESCRIPTION
This can be used to create oclif CLIs that use the system node or that come preloaded with a node binary.See code: src/commands/pack/index.ts
oclif-dev pack:deb
pack CLI into debian package
USAGE
$ oclif-dev pack:deb
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI rootSee code: src/commands/pack/deb.ts
oclif-dev pack:macos
pack CLI into MacOS .pkg
USAGE
$ oclif-dev pack:macos
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI rootSee code: src/commands/pack/macos.ts
oclif-dev pack:win
create windows installer from oclif CLI
USAGE
$ oclif-dev pack:win
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI rootSee code: src/commands/pack/win.ts
oclif-dev publish
publish an oclif CLI to S3
USAGE
$ oclif-dev publish
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
-t, --targets=targets comma-separated targets to pack (e.g.: linux-arm,win32-x64)
DESCRIPTION
"aws-sdk" will need to be installed as a devDependency to publish.See code: src/commands/publish/index.ts
oclif-dev publish:deb
publish deb package built with pack:deb
USAGE
$ oclif-dev publish:deb
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI rootSee code: src/commands/publish/deb.ts
oclif-dev publish:macos
publish macos installers built with pack:macos
USAGE
$ oclif-dev publish:macos
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI rootSee code: src/commands/publish/macos.ts
oclif-dev publish:win
publish windows installers built with pack:win
USAGE
$ oclif-dev publish:win
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI rootSee code: src/commands/publish/win.ts
oclif-dev readme
adds commands to README.md in current directory
USAGE
$ oclif-dev readme
OPTIONS
--dir=dir (required) [default: docs] output directory for multi docs
--multi create a different markdown page for each topic
DESCRIPTION
The readme must have any of the following tags inside of it for it to be replaced or else it will do nothing:
# Usage
<!-- usage -->
# Commands
<!-- commands -->
Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.See code: src/commands/readme.ts