Package Exports

@oclif/dev-cli

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
Commands

Usage

$ npm install -g @oclif/dev-cli
$ oclif-dev COMMAND
running command...
$ oclif-dev (-v|--version|version)
@oclif/dev-cli/1.7.3 linux-x64 node-v9.11.1
$ oclif-dev --help [COMMAND]
USAGE
  $ oclif-dev COMMAND
...

Commands

oclif-dev help [COMMAND]
oclif-dev manifest [PATH]
oclif-dev pack
oclif-dev publish:github
oclif-dev publish:s3
oclif-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 CLI

See code: @oclif/plugin-help

oclif-dev manifest [PATH]

generates plugin manifest json

USAGE
  $ oclif-dev manifest [PATH]

ARGUMENTS
  PATH  [default: .] path to plugin

See code: src/commands/manifest.ts

oclif-dev pack

packages oclif cli into tarballs

USAGE
  $ oclif-dev pack

OPTIONS
  -a, --arch=x64|x86|arm             arch to use for node binary
  -c, --channel=channel              (required) channel to publish (e.g. "stable" or "beta")
  -o, --output=output                output location
  -p, --platform=darwin|linux|win32  OS to use for node binary
  -r, --root=root                    (required) [default: .] path to oclif CLI root
  --node-version=node-version        (required) [default: 9.11.1] node version of binary to get
  --xz                               also create xz tarballs

DESCRIPTION
  packages oclif cli into tarballs

  This can be used to create oclif CLIs that use the system node or that come preloaded with a node binary.
  The default output will be ./dist/mycli-v0.0.0.tar.gz for tarballs without node or 
  ./dist/mycli-v0.0.0-darwin-x64.tar.gz when node is included.

  By default it will not include node. To include node, pass in the --platform and --arch flags.


EXAMPLES
  $ oclif-dev pack
  outputs tarball of CLI in current directory to ./dist/mycli-v0.0.0.tar.gz

  $ oclif-dev pack --platform win32 --arch x64
  outputs tarball of CLI including a windows-x64 binary to ./dist/mycli-v0.0.0-win32-x64.tar.gz

See code: src/commands/pack.ts

oclif-dev publish:github

publish an oclif CLI to GitHub Releases

USAGE
  $ oclif-dev publish:github

OPTIONS
  -r, --root=root              (required) [default: .] path to oclif CLI root
  --draft                      create an unpublished release
  --node-version=node-version  (required) [default: 9.11.1] node version of binary to get
  --prerelease                 identify as prerelease
  --xz                         also create xz tarballs

See code: src/commands/publish/github.ts

oclif-dev publish:s3

publish an oclif CLI to S3

USAGE
  $ oclif-dev publish:s3

OPTIONS
  -b, --bucket=bucket          s3 bucket to use
  -c, --channel=channel        (required) [default: stable] channel to publish (e.g. "stable" or "beta")
  -r, --root=root              (required) [default: .] path to oclif CLI root
  --node-version=node-version  (required) [default: 9.11.1] node version of binary to get
  --xz                         also create xz tarballs

See code: src/commands/publish/s3.ts

oclif-dev readme

adds commands to README.md in current directory

USAGE
  $ oclif-dev readme

OPTIONS
  --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 -->

See code: src/commands/readme.ts