-
Notifications
You must be signed in to change notification settings - Fork 308
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1339 from oclif/mdonnalley/customize-readme
fix: pass in custom command for readme generation
- Loading branch information
Showing
12 changed files
with
147 additions
and
128 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,67 +1,105 @@ | ||
| # `oclif generate` | ||
|
|
||
| generate a new CLI | ||
| This will clone the template repo 'oclif/hello-world' and update package properties | ||
| Generate a new CLI | ||
|
|
||
| - [`oclif generate NAME`](#oclif-generate-name) | ||
| - [`oclif generate command NAME`](#oclif-generate-command-name) | ||
| - [`oclif generate hook NAME`](#oclif-generate-hook-name) | ||
|
|
||
| ## `oclif generate NAME` | ||
|
|
||
| generate a new CLI | ||
| Generate a new CLI | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ oclif generate NAME | ||
| $ oclif generate NAME [--author <value>] [--bin <value>] [--description <value>] [--license <value>] | ||
| [--module-type CommonJS|ESM] [--name <value>] [--owner <value>] [--package-manager npm|yarn] [--repository <value>] | ||
| [-d <value>] [-y] | ||
| ARGUMENTS | ||
| NAME directory name of new project | ||
| NAME Directory name of new project. | ||
| FLAGS | ||
| -d, --output-dir=<value> Directory to build the CLI in. | ||
| -y, --yes Use defaults for all prompts. Individual flags will override defaults. | ||
| --author=<value> Supply answer for prompt: Author | ||
| --bin=<value> Supply answer for prompt: Command bin name the CLI will export | ||
| --description=<value> Supply answer for prompt: Description | ||
| --license=<value> Supply answer for prompt: License | ||
| --module-type=<option> Supply answer for prompt: Select a module type | ||
| <options: CommonJS|ESM> | ||
| --name=<value> Supply answer for prompt: NPM package name | ||
| --owner=<value> Supply answer for prompt: Who is the GitHub owner of repository | ||
| (https://github.com/OWNER/repo) | ||
| --package-manager=<option> Supply answer for prompt: Select a package manager | ||
| <options: npm|yarn> | ||
| --repository=<value> Supply answer for prompt: What is the GitHub name of repository | ||
| (https://github.com/owner/REPO) | ||
| DESCRIPTION | ||
| generate a new CLI | ||
| This will clone the template repo 'oclif/hello-world' and update package properties | ||
| Generate a new CLI | ||
| This will clone the template repo and update package properties. For CommonJS, the 'oclif/hello-world' template will | ||
| be used and for ESM, the 'oclif/hello-world-esm' template will be used. | ||
| EXAMPLES | ||
| Generate a new CLI with prompts for all properties | ||
| $ oclif generate my-cli | ||
| Automatically accept default values for all prompts | ||
| $ oclif generate my-cli --yes | ||
| Supply answers for specific prompts | ||
| $ oclif generate my-cli --module-type CommonJS --author "John Doe" | ||
| Supply answers for specific prompts and accept default values for the rest | ||
| $ oclif generate my-cli --module-type CommonJS --author "John Doe" --yes | ||
| ``` | ||
|
|
||
| _See code: [src/commands/generate.ts](https://github.com/oclif/oclif/blob/v4.5.2/src/commands/generate.ts)_ | ||
| _See code: [src/commands/generate.ts](https://github.com/oclif/oclif/blob/4.6.1-dev.1/src/commands/generate.ts)_ | ||
|
|
||
| ## `oclif generate command NAME` | ||
|
|
||
| add a command to an existing CLI or plugin | ||
| Add a command to an existing CLI or plugin. | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ oclif generate command NAME [--force] | ||
| $ oclif generate command NAME [--commands-dir <value>] [--force] | ||
| ARGUMENTS | ||
| NAME name of command | ||
| FLAGS | ||
| --force overwrite existing files | ||
| --commands-dir=<value> [default: src/commands] The directory to create the command in. | ||
| --force Overwrite existing files. | ||
| DESCRIPTION | ||
| add a command to an existing CLI or plugin | ||
| Add a command to an existing CLI or plugin. | ||
| ``` | ||
|
|
||
| _See code: [src/commands/generate/command.ts](https://github.com/oclif/oclif/blob/v4.5.2/src/commands/generate/command.ts)_ | ||
| _See code: [src/commands/generate/command.ts](https://github.com/oclif/oclif/blob/4.6.1-dev.1/src/commands/generate/command.ts)_ | ||
|
|
||
| ## `oclif generate hook NAME` | ||
|
|
||
| add a hook to an existing CLI or plugin | ||
| Add a hook to an existing CLI or plugin. | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ oclif generate hook NAME [--event <value>] [--force] | ||
| ARGUMENTS | ||
| NAME name of hook (snake_case) | ||
| NAME Name of hook (snake_case). | ||
| FLAGS | ||
| --event=<value> [default: init] event to run hook on | ||
| --force overwrite existing files | ||
| --event=<value> [default: init] Event to run hook on. | ||
| --force Overwrite existing files. | ||
| DESCRIPTION | ||
| add a hook to an existing CLI or plugin | ||
| Add a hook to an existing CLI or plugin. | ||
| ``` | ||
|
|
||
| _See code: [src/commands/generate/hook.ts](https://github.com/oclif/oclif/blob/v4.5.2/src/commands/generate/hook.ts)_ | ||
| _See code: [src/commands/generate/hook.ts](https://github.com/oclif/oclif/blob/4.6.1-dev.1/src/commands/generate/hook.ts)_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,25 +1,25 @@ | ||
| # `oclif manifest` | ||
|
|
||
| generates plugin manifest json | ||
| Generates plugin manifest json (oclif.manifest.json). | ||
|
|
||
| - [`oclif manifest [PATH]`](#oclif-manifest-path) | ||
|
|
||
| ## `oclif manifest [PATH]` | ||
|
|
||
| generates plugin manifest json | ||
| Generates plugin manifest json (oclif.manifest.json). | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ oclif manifest [PATH] [--jit] | ||
| ARGUMENTS | ||
| PATH [default: .] path to plugin | ||
| PATH [default: .] Path to plugin. | ||
| FLAGS | ||
| --[no-]jit append commands from JIT plugins in manifest | ||
| --[no-]jit Append commands from JIT plugins in manifest. | ||
| DESCRIPTION | ||
| generates plugin manifest json | ||
| Generates plugin manifest json (oclif.manifest.json). | ||
| ``` | ||
|
|
||
| _See code: [src/commands/manifest.ts](https://github.com/oclif/oclif/blob/v4.5.2/src/commands/manifest.ts)_ | ||
| _See code: [src/commands/manifest.ts](https://github.com/oclif/oclif/blob/4.6.1-dev.1/src/commands/manifest.ts)_ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,33 +1,33 @@ | ||
| # `oclif promote` | ||
|
|
||
| promote CLI builds to a S3 release channel | ||
| Promote CLI builds to a S3 release channel. | ||
|
|
||
| - [`oclif promote`](#oclif-promote) | ||
|
|
||
| ## `oclif promote` | ||
|
|
||
| promote CLI builds to a S3 release channel | ||
| Promote CLI builds to a S3 release channel. | ||
|
|
||
| ``` | ||
| USAGE | ||
| $ oclif promote --channel <value> -r <value> --sha <value> --version <value> [-d] [--indexes] [-m] [-a | ||
| <value>] [-t <value>] [-w] [--xz] | ||
| FLAGS | ||
| -a, --max-age=<value> [default: 86400] cache control max-age in seconds | ||
| -d, --deb promote debian artifacts | ||
| -m, --macos promote macOS pkg | ||
| -r, --root=<value> (required) [default: .] path to the oclif CLI project root | ||
| -t, --targets=<value> comma-separated targets to promote (e.g.: linux-arm,win32-x64) | ||
| -w, --win promote Windows exe | ||
| --channel=<value> (required) [default: stable] which channel to promote to | ||
| --indexes append the promoted urls into the index files | ||
| --sha=<value> (required) 7-digit short git commit SHA of the CLI to promote | ||
| --version=<value> (required) semantic version of the CLI to promote | ||
| --[no-]xz also upload xz | ||
| -a, --max-age=<value> [default: 86400] Cache control max-age in seconds. | ||
| -d, --deb Promote debian artifacts. | ||
| -m, --macos Promote macOS pkg. | ||
| -r, --root=<value> (required) [default: .] Path to the oclif CLI project root. | ||
| -t, --targets=<value> Comma-separated targets to promote (e.g.: linux-arm,win32-x64). | ||
| -w, --win Promote Windows exe. | ||
| --channel=<value> (required) [default: stable] Channel to promote to. | ||
| --indexes Append the promoted urls into the index files. | ||
| --sha=<value> (required) 7-digit short git commit SHA of the CLI to promote. | ||
| --version=<value> (required) Semantic version of the CLI to promote. | ||
| --[no-]xz Also upload xz. | ||
| DESCRIPTION | ||
| promote CLI builds to a S3 release channel | ||
| Promote CLI builds to a S3 release channel. | ||
| ``` | ||
|
|
||
| _See code: [src/commands/promote.ts](https://github.com/oclif/oclif/blob/v4.5.2/src/commands/promote.ts)_ | ||
| _See code: [src/commands/promote.ts](https://github.com/oclif/oclif/blob/4.6.1-dev.1/src/commands/promote.ts)_ |
Oops, something went wrong.