oclif 2.1.4 → 2.1.5

package/.oclif.manifest.json

@@ -1 +1 @@
-{"version":"2.1.4","commands":{"generate":{"id":"generate","description":"generate a new CLI\nThis will clone the template repo 'oclif/hello-world' and update package properties","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"name","description":"directory name of new project","required":true}]},"manifest":{"id":"manifest","description":"generates plugin manifest json","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"path","description":"path to plugin","default":"."}]},"promote":{"id":"promote","description":"promote CLI builds to a S3 release channel","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to the oclif CLI project root","required":true,"multiple":false,"default":"."},"version":{"name":"version","type":"option","description":"semantic version of the CLI to promote","required":true,"multiple":false},"sha":{"name":"sha","type":"option","description":"7-digit short git commit SHA of the CLI to promote","required":true,"multiple":false},"channel":{"name":"channel","type":"option","description":"which channel to promote to","required":true,"multiple":false,"default":"stable"},"targets":{"name":"targets","type":"option","char":"t","description":"comma-separated targets to promote (e.g.: linux-arm,win32-x64)","multiple":false,"default":"linux-x64,linux-arm,win32-x64,win32-x86,darwin-x64,darwin-arm64"},"deb":{"name":"deb","type":"boolean","char":"d","description":"promote debian artifacts","allowNo":false},"macos":{"name":"macos","type":"boolean","char":"m","description":"promote macOS pkg","allowNo":false},"win":{"name":"win","type":"boolean","char":"w","description":"promote Windows exe","allowNo":false},"max-age":{"name":"max-age","type":"option","char":"a","description":"cache control max-age in seconds","multiple":false,"default":"86400"},"xz":{"name":"xz","type":"boolean","description":"also upload xz","allowNo":true},"indexes":{"name":"indexes","type":"boolean","description":"append the promoted urls into the index files","allowNo":false}},"args":[]},"readme":{"id":"readme","description":"adds commands to README.md in current directory\nThe readme must have any of the following tags inside of it for it to be replaced or else it will do nothing:\n# Usage\n<!-- usage -->\n# Commands\n<!-- commands -->\n\nCustomize the code URL prefix by setting oclif.repositoryPrefix in package.json.\n","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"dir":{"name":"dir","type":"option","description":"output directory for multi docs","required":true,"multiple":false,"default":"docs"},"multi":{"name":"multi","type":"boolean","description":"create a different markdown page for each topic","allowNo":false}},"args":[]},"pack:deb":{"id":"pack:deb","description":"pack CLI into debian package","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."}},"args":[]},"pack:macos":{"id":"pack:macos","description":"pack CLI into macOS .pkg","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."},"additional-cli":{"name":"additional-cli","type":"option","description":"an Oclif CLI other than the one listed in config.bin that should be made available to the user\nthe CLI should already exist in a directory named after the CLI that is the root of the tarball produced by \"oclif pack:tarballs\"","hidden":true,"multiple":false}},"args":[]},"pack:tarballs":{"id":"pack:tarballs","description":"packages oclif CLI into tarballs\n\nThis can be used to create oclif CLIs that use the system node or that come preloaded with a node binary.\n","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."},"targets":{"name":"targets","type":"option","char":"t","description":"comma-separated targets to pack (e.g.: linux-arm,win32-x64)","multiple":false,"default":"linux-x64,linux-arm,win32-x64,win32-x86,darwin-x64,darwin-arm64"},"xz":{"name":"xz","type":"boolean","description":"also build xz","allowNo":true}},"args":[]},"pack:win":{"id":"pack:win","description":"create windows installer from oclif CLI\n\n  This command requires WINDOWS_SIGNING (prefixed with the name of your executable, e.g. OCLIF_WINDOWS_SIGNING_PASS) to be set in the environment","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."},"additional-cli":{"name":"additional-cli","type":"option","description":"an Oclif CLI other than the one listed in config.bin that should be made available to the user\nthe CLI should already exist in a directory named after the CLI that is the root of the tarball produced by \"oclif pack:tarballs\"","hidden":true,"multiple":false}},"args":[]},"upload:deb":{"id":"upload:deb","description":"upload deb package built with pack:deb","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."}},"args":[]},"upload:macos":{"id":"upload:macos","description":"upload macos installers built with pack:macos","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."}},"args":[]},"upload:tarballs":{"id":"upload:tarballs","description":"upload an oclif CLI to S3\n\n\"aws-sdk\" will need to be installed as a devDependency to upload.\n","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."},"targets":{"name":"targets","type":"option","char":"t","description":"comma-separated targets to upload (e.g.: linux-arm,win32-x64)","multiple":false,"default":"linux-x64,linux-arm,win32-x64,win32-x86,darwin-x64,darwin-arm64"},"xz":{"name":"xz","type":"boolean","description":"also upload xz","allowNo":true}},"args":[]},"upload:win":{"id":"upload:win","description":"upload windows installers built with pack:win","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."}},"args":[]}}}
+{"version":"2.1.5","commands":{"generate":{"id":"generate","description":"generate a new CLI\nThis will clone the template repo 'oclif/hello-world' and update package properties","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"name","description":"directory name of new project","required":true}]},"manifest":{"id":"manifest","description":"generates plugin manifest json","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{},"args":[{"name":"path","description":"path to plugin","default":"."}]},"promote":{"id":"promote","description":"promote CLI builds to a S3 release channel","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to the oclif CLI project root","required":true,"multiple":false,"default":"."},"version":{"name":"version","type":"option","description":"semantic version of the CLI to promote","required":true,"multiple":false},"sha":{"name":"sha","type":"option","description":"7-digit short git commit SHA of the CLI to promote","required":true,"multiple":false},"channel":{"name":"channel","type":"option","description":"which channel to promote to","required":true,"multiple":false,"default":"stable"},"targets":{"name":"targets","type":"option","char":"t","description":"comma-separated targets to promote (e.g.: linux-arm,win32-x64)","multiple":false,"default":"linux-x64,linux-arm,win32-x64,win32-x86,darwin-x64,darwin-arm64"},"deb":{"name":"deb","type":"boolean","char":"d","description":"promote debian artifacts","allowNo":false},"macos":{"name":"macos","type":"boolean","char":"m","description":"promote macOS pkg","allowNo":false},"win":{"name":"win","type":"boolean","char":"w","description":"promote Windows exe","allowNo":false},"max-age":{"name":"max-age","type":"option","char":"a","description":"cache control max-age in seconds","multiple":false,"default":"86400"},"xz":{"name":"xz","type":"boolean","description":"also upload xz","allowNo":true},"indexes":{"name":"indexes","type":"boolean","description":"append the promoted urls into the index files","allowNo":false}},"args":[]},"readme":{"id":"readme","description":"adds commands to README.md in current directory\nThe readme must have any of the following tags inside of it for it to be replaced or else it will do nothing:\n# Usage\n<!-- usage -->\n# Commands\n<!-- commands -->\n\nCustomize the code URL prefix by setting oclif.repositoryPrefix in package.json.\n","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"dir":{"name":"dir","type":"option","description":"output directory for multi docs","required":true,"multiple":false,"default":"docs"},"multi":{"name":"multi","type":"boolean","description":"create a different markdown page for each topic","allowNo":false}},"args":[]},"generate:command":{"id":"generate:command","description":"add a command to an existing CLI or plugin","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","description":"overwrite existing files","allowNo":false}},"args":[{"name":"name","description":"name of command","required":true}]},"generate:hook":{"id":"generate:hook","description":"add a hook to an existing CLI or plugin","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"force":{"name":"force","type":"boolean","description":"overwrite existing files","allowNo":false},"event":{"name":"event","type":"option","description":"event to run hook on","multiple":false,"default":"init"}},"args":[{"name":"name","description":"name of hook (snake_case)","required":true}]},"pack:deb":{"id":"pack:deb","description":"pack CLI into debian package","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."}},"args":[]},"pack:macos":{"id":"pack:macos","description":"pack CLI into macOS .pkg","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."},"additional-cli":{"name":"additional-cli","type":"option","description":"an Oclif CLI other than the one listed in config.bin that should be made available to the user\nthe CLI should already exist in a directory named after the CLI that is the root of the tarball produced by \"oclif pack:tarballs\"","hidden":true,"multiple":false}},"args":[]},"pack:tarballs":{"id":"pack:tarballs","description":"packages oclif CLI into tarballs\n\nThis can be used to create oclif CLIs that use the system node or that come preloaded with a node binary.\n","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."},"targets":{"name":"targets","type":"option","char":"t","description":"comma-separated targets to pack (e.g.: linux-arm,win32-x64)","multiple":false,"default":"linux-x64,linux-arm,win32-x64,win32-x86,darwin-x64,darwin-arm64"},"xz":{"name":"xz","type":"boolean","description":"also build xz","allowNo":true}},"args":[]},"pack:win":{"id":"pack:win","description":"create windows installer from oclif CLI\n\n  This command requires WINDOWS_SIGNING (prefixed with the name of your executable, e.g. OCLIF_WINDOWS_SIGNING_PASS) to be set in the environment","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."},"additional-cli":{"name":"additional-cli","type":"option","description":"an Oclif CLI other than the one listed in config.bin that should be made available to the user\nthe CLI should already exist in a directory named after the CLI that is the root of the tarball produced by \"oclif pack:tarballs\"","hidden":true,"multiple":false}},"args":[]},"upload:deb":{"id":"upload:deb","description":"upload deb package built with pack:deb","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."}},"args":[]},"upload:macos":{"id":"upload:macos","description":"upload macos installers built with pack:macos","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."}},"args":[]},"upload:tarballs":{"id":"upload:tarballs","description":"upload an oclif CLI to S3\n\n\"aws-sdk\" will need to be installed as a devDependency to upload.\n","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."},"targets":{"name":"targets","type":"option","char":"t","description":"comma-separated targets to upload (e.g.: linux-arm,win32-x64)","multiple":false,"default":"linux-x64,linux-arm,win32-x64,win32-x86,darwin-x64,darwin-arm64"},"xz":{"name":"xz","type":"boolean","description":"also upload xz","allowNo":true}},"args":[]},"upload:win":{"id":"upload:win","description":"upload windows installers built with pack:win","strict":true,"pluginName":"oclif","pluginAlias":"oclif","pluginType":"core","aliases":[],"flags":{"root":{"name":"root","type":"option","char":"r","description":"path to oclif CLI root","required":true,"multiple":false,"default":"."}},"args":[]}}}

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [2.1.5](https://github.com/oclif/oclif/compare/v2.1.4...v2.1.5) (2022-01-10)
+
 ### [2.1.4](https://github.com/oclif/oclif/compare/v2.1.3...v2.1.4) (2022-01-10)
 
 

package/README.md

@@ -5,10 +5,8 @@
 oclif: Node.JS Open CLI Framework
 =================================
 
-[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/oclif)
 [![Version](https://img.shields.io/npm/v/oclif.svg)](https://npmjs.org/package/oclif)
 [![CircleCI](https://circleci.com/gh/oclif/oclif/tree/main.svg?style=shield)](https://circleci.com/gh/oclif/oclif/tree/main)
-[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/oclif/oclif?branch=main&svg=true)](https://ci.appveyor.com/project/heroku/oclif/branch/main)
 [![Downloads/week](https://img.shields.io/npm/dw/@oclif/command.svg)](https://npmjs.org/package/@oclif/core)
 [![License](https://img.shields.io/npm/l/oclif.svg)](https://github.com/oclif/oclif/blob/main/package.json)
 
@@ -17,6 +15,7 @@ oclif: Node.JS Open CLI Framework
 * [🚀 Getting Started Tutorial](#-getting-started-tutorial)
 * [✨ Features](#-features)
 * [📌 Requirements](#-requirements)
+* [📌 Migrating from V1](#-migrating-from-v1)
 * [🏗 Usage](#-usage)
 * [📚 Examples](#-examples)
 * [🔨 Commands](#-commands)
@@ -40,15 +39,14 @@ The [Getting Started tutorial](http://oclif.io/docs/introduction) is a step-by-s
 * **Flag/Argument parsing** - No CLI framework would be complete without a flag parser. We've built a custom one from years of experimentation that we feel consistently handles user input flexible enough for the user to be able to use the CLI in ways they expect, but without compromising strictness guarantees to the developer.
 * **Super Speed** - The overhead for running an oclif CLI command is almost nothing. [It requires very few dependencies](https://www.npmjs.com/package/@oclif/command?activeTab=dependencies) (only 35 dependencies in a minimal setup—including all transitive dependencies). Also, only the command to be executed will be required with node. So large CLIs with many commands will load equally as fast as a small one with a single command.
 * **CLI Generator** - Run a single command to scaffold out a fully functional CLI and get started quickly. See [Usage](#-usage) below.
-* **Testing Helpers** - We've put a lot of work into making commands easier to test and mock out stdout/stderr. The generator will automatically create [scaffolded tests](https://github.com/oclif/example-multi-ts/blob/master/test/commands/hello.test.ts).
+* **Testing Helpers** - We've put a lot of work into making commands easier to test and mock out stdout/stderr. The generator will automatically create [scaffolded tests](https://github.com/oclif/hello-world/blob/main/test/commands/hello.test.ts).
 * **Auto-documentation** - By default you can pass `--help` to the CLI to get help such as flag options and argument information. This information is also automatically placed in the README whenever the npm package of the CLI is published. See the [multi-command CLI example](https://github.com/oclif/example-multi-ts)
 * **Plugins** - Using [plugins](https://oclif.io/docs/plugins), users of the CLI can extend it with new functionality, a CLI can be split into modular components, and functionality can be shared amongst multiple CLIs. See [Building your own plugin](https://oclif.io/docs/plugins#building-your-own-plugin).
 * **Hooks** - Use lifecycle hooks to run functionality any time a CLI starts, or on custom triggers. Use this whenever custom functionality needs to be shared between various components of the CLI.
-* **TypeScript (or not)** - Everything in the core of oclif is written in TypeScript and the generator can build fully configured TypeScript CLIs or plain JavaScript CLIs. By virtue of static properties in TypeScript the syntax is a bit cleaner in TypeScript—but everything will work no matter which language you choose. If you use plugins support, the CLI will automatically use `ts-node` to run the plugins enabling you to use TypeScript with minimal-to-no boilerplate needed for any oclif CLI.
+* **TypeScript** - Everything in the core of oclif is written in TypeScript and the generator will build fully configured TypeScript CLIs. If you use plugins support, the CLI will automatically use `ts-node` to run the plugins enabling you to use TypeScript with minimal-to-no boilerplate needed for any oclif CLI.
 * **Auto-updating Installers** - oclif can package your CLI into [different installers](https://oclif.io/docs/releasing) that will not require the user to already have node installed on the machine. These can be made auto-updatable by using [plugin-update](https://github.com/oclif/plugin-update).
 * **Everything is Customizable** - Pretty much anything can be swapped out and replaced inside oclif if needed—including the arg/flag parser.
 * **Autocomplete** - Automatically include autocomplete for your CLI. This includes not only command names and flag names, but flag values as well. For example, it's possible to configure the Heroku CLI to have completions for Heroku app names:
-<!--* **Coming soon: man pages** - In addition to in-CLI help through `-help` and the README markdown help generation, the CLI can also automatically create man pages for all of its commands.-->
 
 ```
 $ heroku info --app=<tab><tab> # will complete with all the Heroku apps a user has in their account
@@ -56,7 +54,33 @@ $ heroku info --app=<tab><tab> # will complete with all the Heroku apps a user h
 
 # 📌 Requirements
 
-Currently, Node 8+ is supported. We support the [LTS versions](https://nodejs.org/en/about/releases) of Node. You can add the [node](https://www.npmjs.com/package/node) package to your CLI to ensure users are running a specific version of Node.
+Currently, Node 12+ is supported. We support the [LTS versions](https://nodejs.org/en/about/releases) of Node. You can add the [node](https://www.npmjs.com/package/node) package to your CLI to ensure users are running a specific version of Node.
+
+# 📌 Migrating from V1
+
+If you have been using version 1 of the [`oclif` CLI](https://github.com/oclif/oclif/tree/v1.18.4) there are some important differences to note when using the latest version.
+
+## Breaking Changes
+
+- `oclif multi`, `oclif plugin`, and `oclif single` have all been removed in favor of `oclif generate`, which generates an oclif based CLI using the [hello-world example repo](https://github.com/oclif/hello-world).
+  - The reason is that there's not enough of a meaningful difference between a "multi command cli", a "single command cli", and a "plugin" to justify the maintenance cost. The generated CLI can be easily used for any of those use cases.
+- `oclif hook` is now `oclif generate:hook`
+- `oclif command` is now `oclif generate:command`
+
+## New Commands
+
+Version 2 now includes all the commands from the [`oclif-dev` CLI](https://github.com/oclif/dev-cli). This means that you can now use a single CLI for all your oclif needs. These commands include:
+- `oclif manifest`
+- `oclif pack`
+- `oclif pack:deb`
+- `oclif pack:macos`
+- `oclif pack:win`
+- `oclif upload` (formerly known as `oclif-dev publish`)
+- `oclif upload:deb` (formerly known as `oclif-dev publish:deb`)
+- `oclif upload:macos` (formerly known as `oclif-dev publish:macos`)
+- `oclif upload:win` (formerly known as `oclif-dev publish:win`)
+- `oclif readme`
+
 
 # 🏗 Usage
 
@@ -82,27 +106,28 @@ hello world from ./src/hello.js!
 
 # 📚 Examples
 
-* TypeScript
-  * [Multi-command CLI](https://github.com/oclif/example-multi-ts)
-  * [Single-command CLI](https://github.com/oclif/example-single-ts)
-  * [Multi-command CLI Plugin](https://github.com/oclif/example-plugin-ts)
+* [Hello-World](https://github.com/oclif/hello-world)
+* [Salesforce CLI](https://github.com/salesforcecli/cli)
+* [Heroku CLI](https://github.com/heroku/cli)
 
 # 🔨 Commands
 
 <!-- commands -->
 * [`oclif generate NAME`](#oclif-generate-name)
+* [`oclif generate command NAME`](#oclif-generate-command-name)
+* [`oclif generate hook NAME`](#oclif-generate-hook-name)
 * [`oclif help [COMMAND]`](#oclif-help-command)
 * [`oclif manifest [PATH]`](#oclif-manifest-path)
-* [`oclif pack:deb`](#oclif-packdeb)
-* [`oclif pack:macos`](#oclif-packmacos)
-* [`oclif pack:tarballs`](#oclif-packtarballs)
-* [`oclif pack:win`](#oclif-packwin)
+* [`oclif pack deb`](#oclif-pack-deb)
+* [`oclif pack macos`](#oclif-pack-macos)
+* [`oclif pack tarballs`](#oclif-pack-tarballs)
+* [`oclif pack win`](#oclif-pack-win)
 * [`oclif promote`](#oclif-promote)
 * [`oclif readme`](#oclif-readme)
-* [`oclif upload:deb`](#oclif-uploaddeb)
-* [`oclif upload:macos`](#oclif-uploadmacos)
-* [`oclif upload:tarballs`](#oclif-uploadtarballs)
-* [`oclif upload:win`](#oclif-uploadwin)
+* [`oclif upload deb`](#oclif-upload-deb)
+* [`oclif upload macos`](#oclif-upload-macos)
+* [`oclif upload tarballs`](#oclif-upload-tarballs)
+* [`oclif upload win`](#oclif-upload-win)
 
 ## `oclif generate NAME`
 
@@ -121,7 +146,44 @@ DESCRIPTION
   This will clone the template repo 'oclif/hello-world' and update package properties
 ```
 
-_See code: [src/commands/generate.ts](https://github.com/oclif/oclif/blob/v2.1.3/src/commands/generate.ts)_
+_See code: [src/commands/generate.ts](https://github.com/oclif/oclif/blob/v2.1.4/src/commands/generate.ts)_
+
+## `oclif generate command NAME`
+
+add a command to an existing CLI or plugin
+
+```
+USAGE
+  $ oclif generate command [NAME] [--force]
+
+ARGUMENTS
+  NAME  name of command
+
+FLAGS
+  --force  overwrite existing files
+
+DESCRIPTION
+  add a command to an existing CLI or plugin
+```
+
+## `oclif generate hook NAME`
+
+add a hook to an existing CLI or plugin
+
+```
+USAGE
+  $ oclif generate hook [NAME] [--force] [--event <value>]
+
+ARGUMENTS
+  NAME  name of hook (snake_case)
+
+FLAGS
+  --event=<value>  [default: init] event to run hook on
+  --force          overwrite existing files
+
+DESCRIPTION
+  add a hook to an existing CLI or plugin
+```
 
 ## `oclif help [COMMAND]`
 
@@ -158,15 +220,15 @@ DESCRIPTION
   generates plugin manifest json
 ```
 
-_See code: [src/commands/manifest.ts](https://github.com/oclif/oclif/blob/v2.1.3/src/commands/manifest.ts)_
+_See code: [src/commands/manifest.ts](https://github.com/oclif/oclif/blob/v2.1.4/src/commands/manifest.ts)_
 
-## `oclif pack:deb`
+## `oclif pack deb`
 
 pack CLI into debian package
 
 ```
 USAGE
-  $ oclif pack:deb -r <value>
+  $ oclif pack deb -r <value>
 
 FLAGS
   -r, --root=<value>  (required) [default: .] path to oclif CLI root
@@ -175,15 +237,13 @@ DESCRIPTION
   pack CLI into debian package
 ```
 
-_See code: [src/commands/pack/deb.ts](https://github.com/oclif/oclif/blob/v2.1.3/src/commands/pack/deb.ts)_
-
-## `oclif pack:macos`
+## `oclif pack macos`
 
 pack CLI into macOS .pkg
 
 ```
 USAGE
-  $ oclif pack:macos -r <value>
+  $ oclif pack macos -r <value>
 
 FLAGS
   -r, --root=<value>  (required) [default: .] path to oclif CLI root
@@ -192,15 +252,13 @@ DESCRIPTION
   pack CLI into macOS .pkg
 ```
 
-_See code: [src/commands/pack/macos.ts](https://github.com/oclif/oclif/blob/v2.1.3/src/commands/pack/macos.ts)_
-
-## `oclif pack:tarballs`
+## `oclif pack tarballs`
 
 packages oclif CLI into tarballs
 
 ```
 USAGE
-  $ oclif pack:tarballs -r <value> [-t <value>] [--xz]
+  $ oclif pack tarballs -r <value> [-t <value>] [--xz]
 
 FLAGS
   -r, --root=<value>     (required) [default: .] path to oclif CLI root
@@ -214,15 +272,13 @@ 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/tarballs.ts](https://github.com/oclif/oclif/blob/v2.1.3/src/commands/pack/tarballs.ts)_
-
-## `oclif pack:win`
+## `oclif pack win`
 
 create windows installer from oclif CLI
 
 ```
 USAGE
-  $ oclif pack:win -r <value>
+  $ oclif pack win -r <value>
 
 FLAGS
   -r, --root=<value>  (required) [default: .] path to oclif CLI root
@@ -234,8 +290,6 @@ DESCRIPTION
   be set in the environment
 ```
 
-_See code: [src/commands/pack/win.ts](https://github.com/oclif/oclif/blob/v2.1.3/src/commands/pack/win.ts)_
-
 ## `oclif promote`
 
 promote CLI builds to a S3 release channel
@@ -263,7 +317,7 @@ DESCRIPTION
   promote CLI builds to a S3 release channel
 ```
 
-_See code: [src/commands/promote.ts](https://github.com/oclif/oclif/blob/v2.1.3/src/commands/promote.ts)_
+_See code: [src/commands/promote.ts](https://github.com/oclif/oclif/blob/v2.1.4/src/commands/promote.ts)_
 
 ## `oclif readme`
 
@@ -293,15 +347,15 @@ DESCRIPTION
   Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
 ```
 
-_See code: [src/commands/readme.ts](https://github.com/oclif/oclif/blob/v2.1.3/src/commands/readme.ts)_
+_See code: [src/commands/readme.ts](https://github.com/oclif/oclif/blob/v2.1.4/src/commands/readme.ts)_
 
-## `oclif upload:deb`
+## `oclif upload deb`
 
 upload deb package built with pack:deb
 
 ```
 USAGE
-  $ oclif upload:deb -r <value>
+  $ oclif upload deb -r <value>
 
 FLAGS
   -r, --root=<value>  (required) [default: .] path to oclif CLI root
@@ -310,15 +364,13 @@ DESCRIPTION
   upload deb package built with pack:deb
 ```
 
-_See code: [src/commands/upload/deb.ts](https://github.com/oclif/oclif/blob/v2.1.3/src/commands/upload/deb.ts)_
-
-## `oclif upload:macos`
+## `oclif upload macos`
 
 upload macos installers built with pack:macos
 
 ```
 USAGE
-  $ oclif upload:macos -r <value>
+  $ oclif upload macos -r <value>
 
 FLAGS
   -r, --root=<value>  (required) [default: .] path to oclif CLI root
@@ -327,15 +379,13 @@ DESCRIPTION
   upload macos installers built with pack:macos
 ```
 
-_See code: [src/commands/upload/macos.ts](https://github.com/oclif/oclif/blob/v2.1.3/src/commands/upload/macos.ts)_
-
-## `oclif upload:tarballs`
+## `oclif upload tarballs`
 
 upload an oclif CLI to S3
 
 ```
 USAGE
-  $ oclif upload:tarballs -r <value> [-t <value>] [--xz]
+  $ oclif upload tarballs -r <value> [-t <value>] [--xz]
 
 FLAGS
   -r, --root=<value>     (required) [default: .] path to oclif CLI root
@@ -349,15 +399,13 @@ DESCRIPTION
   "aws-sdk" will need to be installed as a devDependency to upload.
 ```
 
-_See code: [src/commands/upload/tarballs.ts](https://github.com/oclif/oclif/blob/v2.1.3/src/commands/upload/tarballs.ts)_
-
-## `oclif upload:win`
+## `oclif upload win`
 
 upload windows installers built with pack:win
 
 ```
 USAGE
-  $ oclif upload:win -r <value>
+  $ oclif upload win -r <value>
 
 FLAGS
   -r, --root=<value>  (required) [default: .] path to oclif CLI root
@@ -365,15 +413,11 @@ FLAGS
 DESCRIPTION
   upload windows installers built with pack:win
 ```
-
-_See code: [src/commands/upload/win.ts](https://github.com/oclif/oclif/blob/v2.1.3/src/commands/upload/win.ts)_
 <!-- commandsstop -->
 
 # 🏭 Related Repositories
 
-* [@oclif/command](https://github.com/oclif/command) - Base command for oclif. This can be used directly without the generator.
-* [@oclif/config](https://github.com/oclif/config) - Most of the core setup for oclif lives here.
-* [@oclif/errors](https://github.com/oclif/errors) - Renders and logs errors from commands.
+* [@oclif/core](https://github.com/oclif/core) - Base library for oclif. This can be used directly without the generator.
 * [@oclif/cli-ux](https://github.com/oclif/cli-ux) - Library for common CLI UI utilities.
 * [@oclif/test](https://github.com/oclif/test) - Test helper for oclif.
 
@@ -384,4 +428,4 @@ _See code: [src/commands/upload/win.ts](https://github.com/oclif/oclif/blob/v2.1
 
 # 📣 Feedback
 
-If you have any suggestions or want to let us know what you think of oclif, send us a message at <heroku-cli@salesforce.com>
+If you have any suggestions or want to let us know what you think of oclif, send us a message at <alm-cli@salesforce.com>

package/bin/dev

@@ -11,9 +11,8 @@ process.env.NODE_ENV = 'development'
 require('ts-node').register({project})
 
 // In dev mode, always show stack traces
-// Waiting for https://github.com/oclif/core/pull/147
-// oclif.settings.debug = true;
-oclif.settings.disableJsonFlag = true
+oclif.settings.debug = true;
+
 
 // Start the CLI
 oclif.run().then(oclif.flush).catch(oclif.Errors.handle)

package/lib/commands/generate/command.d.ts

@@ -0,0 +1,13 @@
+import CommandBase from './../../command-base';
+export default class GenerateCommand extends CommandBase {
+    static description: string;
+    static flags: {
+        force: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    run(): Promise<void>;
+}

package/lib/commands/generate/command.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_base_1 = require("./../../command-base");
+const core_1 = require("@oclif/core");
+class GenerateCommand extends command_base_1.default {
+    async run() {
+        const { args, flags } = await this.parse(GenerateCommand);
+        await super.generate('command', {
+            name: args.name,
+            force: flags.force,
+        });
+    }
+}
+exports.default = GenerateCommand;
+GenerateCommand.description = 'add a command to an existing CLI or plugin';
+GenerateCommand.flags = {
+    force: core_1.Flags.boolean({ description: 'overwrite existing files' }),
+};
+GenerateCommand.args = [
+    { name: 'name', description: 'name of command', required: true },
+];

package/lib/commands/generate/hook.d.ts

@@ -0,0 +1,14 @@
+import CommandBase from './../../command-base';
+export default class GenerateHook extends CommandBase {
+    static description: string;
+    static flags: {
+        force: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        event: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    run(): Promise<void>;
+}

package/lib/commands/generate/hook.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_base_1 = require("./../../command-base");
+const core_1 = require("@oclif/core");
+class GenerateHook extends command_base_1.default {
+    async run() {
+        const { args, flags } = await this.parse(GenerateHook);
+        await super.generate('hook', {
+            name: args.name,
+            event: flags.event,
+            force: flags.force,
+        });
+    }
+}
+exports.default = GenerateHook;
+GenerateHook.description = 'add a hook to an existing CLI or plugin';
+GenerateHook.flags = {
+    force: core_1.Flags.boolean({ description: 'overwrite existing files' }),
+    event: core_1.Flags.string({ description: 'event to run hook on', default: 'init' }),
+};
+GenerateHook.args = [
+    { name: 'name', description: 'name of hook (snake_case)', required: true },
+];

package/lib/generators/cli.d.ts

@@ -1,5 +1,5 @@
 import * as Generator from 'yeoman-generator';
-declare class App extends Generator {
+export default class CLI extends Generator {
     options: {
         defaults?: boolean;
         yarn: boolean;
@@ -41,4 +41,3 @@ declare class App extends Generator {
     end(): void;
     private _gitignore;
 }
-export = App;

package/lib/generators/cli.js

@@ -1,4 +1,5 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 const child_process_1 = require("child_process");
 const fs = require("fs");
 const _ = require("lodash");
@@ -16,7 +17,7 @@ try {
     hasYarn = true;
 }
 catch (_a) { }
-class App extends Generator {
+class CLI extends Generator {
     constructor(args, opts) {
         super(args, opts);
         this.name = opts.name;
@@ -28,8 +29,8 @@ class App extends Generator {
     async prompting() {
         const msg = 'Time to build an oclif CLI!';
         this.log(yosay(`${msg} Version: ${version}`));
-        (0, child_process_1.execSync)(`git clone https://github.com/oclif/hello-world.git ${path.resolve(this.name)}`);
-        fs.rmdirSync(`${path.resolve(this.name, '.git')}`, { recursive: true });
+        (0, child_process_1.execSync)(`git clone https://github.com/oclif/hello-world.git "${path.resolve(this.name)}"`);
+        fs.rmSync(`${path.resolve(this.name, '.git')}`, { recursive: true });
         this.destinationRoot(path.resolve(this.name));
         process.chdir(this.destinationRoot());
         this.githubUser = await this.user.github.username().catch(debug);
@@ -37,7 +38,7 @@ class App extends Generator {
         let repository = this.destinationRoot().split(path.sep).slice(-2).join('/');
         if (this.githubUser)
             repository = `${this.githubUser}/${repository.split('/')[1]}`;
-        const defaults = Object.assign(Object.assign({ name: this.determineAppname().replace(/ /g, '-'), version: '0.0.0', license: 'MIT', author: this.githubUser ? `${this.user.git.name()} @${this.githubUser}` : this.user.git.name(), dependencies: {}, repository }, this.pjson), { engines: Object.assign({ node: '>=8.0.0' }, this.pjson.engines), options: this.options });
+        const defaults = Object.assign(Object.assign({ name: this.determineAppname().replace(/ /g, '-'), version: '0.0.0', license: 'MIT', author: this.githubUser ? `${this.user.git.name()} @${this.githubUser}` : this.user.git.name(), dependencies: {}, repository }, this.pjson), { engines: Object.assign({ node: '>=12.0.0' }, this.pjson.engines), options: this.options });
         this.repository = defaults.repository;
         if (this.repository && this.repository.url) {
             this.repository = this.repository.url;
@@ -179,4 +180,4 @@ class App extends Generator {
             .join('\n') + '\n';
     }
 }
-module.exports = App;
+exports.default = CLI;

package/lib/generators/command.d.ts

@@ -0,0 +1,10 @@
+import * as Generator from 'yeoman-generator';
+import { GeneratorOptions, PackageJson } from '../types';
+export default class Command extends Generator {
+    options: GeneratorOptions;
+    pjson: PackageJson;
+    constructor(args: string | string[], opts: GeneratorOptions);
+    private hasMocha;
+    prompting(): Promise<void>;
+    writing(): void;
+}

package/lib/generators/command.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const _ = require("lodash");
+const path = require("path");
+const Generator = require("yeoman-generator");
+const yosay = require("yosay");
+const { version } = require('../../package.json');
+class Command extends Generator {
+    constructor(args, opts) {
+        super(args, opts);
+        this.options = {
+            name: opts.name,
+            defaults: opts.defaults,
+            force: opts.force,
+        };
+    }
+    hasMocha() {
+        var _a;
+        return Boolean((_a = this.pjson.devDependencies) === null || _a === void 0 ? void 0 : _a.mocha);
+    }
+    async prompting() {
+        this.pjson = this.fs.readJSON('package.json');
+        if (!this.pjson)
+            throw new Error('not in a project directory');
+        this.pjson.oclif = this.pjson.oclif || {};
+        this.log(yosay(`Adding a command to ${this.pjson.name} Version: ${version}`));
+    }
+    writing() {
+        const cmdPath = this.options.name.split(':').join('/');
+        this.sourceRoot(path.join(__dirname, '../../templates'));
+        let bin = this.pjson.oclif.bin || this.pjson.oclif.dirname || this.pjson.name;
+        if (bin.includes('/'))
+            bin = bin.split('/').pop();
+        const cmd = `${bin} ${this.options.name}`;
+        const commandPath = this.destinationPath(`src/commands/${cmdPath}.ts`);
+        const opts = Object.assign(Object.assign({}, this.options), { bin, cmd, _, type: 'command', path: commandPath });
+        this.fs.copyTpl(this.templatePath('src/command.ts.ejs'), commandPath, opts);
+        if (this.hasMocha()) {
+            this.fs.copyTpl(this.templatePath('test/command.test.ts.ejs'), this.destinationPath(`test/commands/${cmdPath}.test.ts`), opts);
+        }
+    }
+}
+exports.default = Command;

package/lib/generators/hook.d.ts

@@ -0,0 +1,13 @@
+import * as Generator from 'yeoman-generator';
+import { GeneratorOptions, PackageJson } from '../types';
+export interface Options extends GeneratorOptions {
+    event: string;
+}
+export default class Hook extends Generator {
+    options: Options;
+    pjson: PackageJson;
+    constructor(args: string | string[], options: Options);
+    private hasMocha;
+    prompting(): Promise<void>;
+    writing(): void;
+}

package/lib/generators/hook.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const _ = require("lodash");
+const path = require("path");
+const Generator = require("yeoman-generator");
+const yosay = require("yosay");
+const { version } = require('../../package.json');
+class Hook extends Generator {
+    constructor(args, options) {
+        super(args, options);
+        this.options = options;
+    }
+    hasMocha() {
+        var _a;
+        return Boolean((_a = this.pjson.devDependencies) === null || _a === void 0 ? void 0 : _a.mocha);
+    }
+    async prompting() {
+        this.pjson = this.fs.readJSON('package.json');
+        this.pjson.oclif = this.pjson.oclif || {};
+        if (!this.pjson)
+            throw new Error('not in a project directory');
+        this.log(yosay(`Adding a ${this.options.event} hook to ${this.pjson.name} Version: ${version}`));
+    }
+    writing() {
+        this.sourceRoot(path.join(__dirname, '../../templates'));
+        this.fs.copyTpl(this.templatePath('src/hook.ts.ejs'), this.destinationPath(`src/hooks/${this.options.event}/${this.options.name}.ts`), this);
+        if (this.hasMocha()) {
+            this.fs.copyTpl(this.templatePath('test/hook.test.ts.ejs'), this.destinationPath(`test/hooks/${this.options.event}/${this.options.name}.test.ts`), this);
+        }
+        this.pjson.oclif = this.pjson.oclif || {};
+        this.pjson.oclif.hooks = this.pjson.oclif.hooks || {};
+        const hooks = this.pjson.oclif.hooks;
+        const p = `./src/hooks/${this.options.event}/${this.options.name}`;
+        if (hooks[this.options.event]) {
+            hooks[this.options.event] = _.castArray(hooks[this.options.event]);
+            hooks[this.options.event] = hooks[this.options.event].concat(p);
+        }
+        else {
+            this.pjson.oclif.hooks[this.options.event] = p;
+        }
+        this.fs.writeJSON(this.destinationPath('./package.json'), this.pjson);
+    }
+}
+exports.default = Hook;

package/lib/types/index.d.ts

@@ -0,0 +1,16 @@
+import * as Generator from 'yeoman-generator';
+export interface PackageJson {
+    name: string;
+    devDependencies: Record<string, string>;
+    dependencies: Record<string, string>;
+    oclif: {
+        bin: string;
+        dirname: string;
+        hooks: Record<string, string | string[]>;
+    };
+}
+export interface GeneratorOptions extends Generator.GeneratorOptions {
+    name: string;
+    defaults?: boolean;
+    force?: boolean;
+}

package/lib/types/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "oclif",
   "description": "oclif: create your own CLI",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "author": "Salesforce",
   "bin": {
     "oclif": "bin/run"
@@ -96,6 +96,7 @@
     ],
     "bin": "oclif",
     "dirname": "oclif",
+    "topicSeparator": " ",
     "macos": {
       "identifier": "com.oclif.cli",
       "sign": "Developer ID Installer: Heroku INC"

package/templates/src/command.ts.ejs

@@ -0,0 +1,29 @@
+import {Command, Flags} from '@oclif/core'
+<%_ const klass = _.upperFirst(_.camelCase(name)) _%>
+
+export default class <%- klass %> extends Command {
+  static description = 'describe the command here'
+
+  static examples = [
+    '<%%= config.bin %> <%%= command.id %>',
+  ]
+
+  static flags = {
+    // flag with a value (-n, --name=VALUE)
+    name: Flags.string({char: 'n', description: 'name to print'}),
+    // flag with no value (-f, --force)
+    force: Flags.boolean({char: 'f'}),
+  }
+
+  static args = [{name: 'file'}]
+
+  public async run(): Promise<void> {
+    const {args, flags} = await this.parse(<%- klass %>)
+
+    const name = flags.name ?? 'world'
+    this.log(`hello ${name} from <%- path.replace(/\\/g, '\\\\') %>`)
+    if (args.file && flags.force) {
+      this.log(`you input --force and --file: ${args.file}`)
+    }
+  }
+}

package/templates/src/hook.ts.ejs

@@ -0,0 +1,7 @@
+import {Hook} from '@oclif/core'
+
+const hook: Hook<'<%- options.event %>'> = async function (opts) {
+  process.stdout.write(`example hook running ${opts.id}\n`)
+}
+
+export default hook

package/templates/test/command.test.ts.ejs

@@ -0,0 +1,17 @@
+import {expect, test} from '@oclif/test'
+
+describe('<%- name %>', () => {
+  test
+  .stdout()
+  .command(['<%- name %>'])
+  .it('runs hello', ctx => {
+    expect(ctx.stdout).to.contain('hello world')
+  })
+
+  test
+  .stdout()
+  .command(['<%- name %>', '--name', 'jeff'])
+  .it('runs hello --name jeff', ctx => {
+    expect(ctx.stdout).to.contain('hello jeff')
+  })
+})

package/templates/test/hook.test.ts.ejs

@@ -0,0 +1,9 @@
+import {expect, test} from '@oclif/test'
+
+describe('hooks', () => {
+  test
+  .stdout()
+  .hook('init', {id: 'mycommand'})
+  .do(output => expect(output.stdout).to.contain('example hook running mycommand'))
+  .it('shows a message')
+})