Back to Gems
oclif/dev-cli(opens in a new tab)
Language: TypeScript
- stars
- 60
- watchers
- 0
- forks
- 54
- open issues
- 80
- Last updated
- 04/10/2022
gem-hunterLanguage: TypeScript
This library has been replaced by oclif and is now in maintenance mode. We will only consider PRs that address security concerns.
helpers for oclif CLIs
$ 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 ...
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 readmedisplay help for oclif-dev
USAGE
$ oclif-dev help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
generates plugin manifest json
USAGE
$ oclif-dev manifest [PATH]
ARGUMENTS
PATH [default: .] path to plugin
See code: src/commands/manifest.ts
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
pack CLI into debian package
USAGE
$ oclif-dev pack:deb
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
See code: src/commands/pack/deb.ts
pack CLI into MacOS .pkg
USAGE
$ oclif-dev pack:macos
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
See code: src/commands/pack/macos.ts
create windows installer from oclif CLI
USAGE
$ oclif-dev pack:win
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
See code: src/commands/pack/win.ts
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
publish deb package built with pack:deb
USAGE
$ oclif-dev publish:deb
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
See code: src/commands/publish/deb.ts
publish macos installers built with pack:macos
USAGE
$ oclif-dev publish:macos
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
See code: src/commands/publish/macos.ts
publish windows installers built with pack:win
USAGE
$ oclif-dev publish:win
OPTIONS
-r, --root=root (required) [default: .] path to oclif CLI root
See code: src/commands/publish/win.ts
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