fix: broken links (oclif#1333)

docs/generate.md

@@ -0,0 +1,67 @@
+# `oclif generate`
+
+generate a new CLI
+This will clone the template repo 'oclif/hello-world' and update package properties
+
+- [`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
+
+```
+USAGE
+  $ oclif generate NAME
+
+ARGUMENTS
+  NAME  directory name of new project
+
+DESCRIPTION
+  generate a new CLI
+  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/v4.5.2/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
+```
+
+_See code: [src/commands/generate/command.ts](https://github.com/oclif/oclif/blob/v4.5.2/src/commands/generate/command.ts)_
+
+## `oclif generate hook NAME`
+
+add a hook to an existing CLI or plugin
+
+```
+USAGE
+  $ oclif generate hook NAME [--event <value>] [--force]
+
+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
+```
+
+_See code: [src/commands/generate/hook.ts](https://github.com/oclif/oclif/blob/v4.5.2/src/commands/generate/hook.ts)_

docs/help.md

@@ -0,0 +1,25 @@
+# `oclif help`
+
+Display help for oclif.
+
+- [`oclif help [COMMANDS]`](#oclif-help-commands)
+
+## `oclif help [COMMANDS]`
+
+Display help for oclif.
+
+```
+USAGE
+  $ oclif help [COMMANDS] [-n]
+
+ARGUMENTS
+  COMMANDS  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for oclif.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.0.14/src/commands/help.ts)_

docs/manifest.md

@@ -0,0 +1,25 @@
+# `oclif manifest`
+
+generates plugin manifest json
+
+- [`oclif manifest [PATH]`](#oclif-manifest-path)
+
+## `oclif manifest [PATH]`
+
+generates plugin manifest json
+
+```
+USAGE
+  $ oclif manifest [PATH] [--jit]
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  --[no-]jit  append commands from JIT plugins in manifest
+
+DESCRIPTION
+  generates plugin manifest json
+```
+
+_See code: [src/commands/manifest.ts](https://github.com/oclif/oclif/blob/v4.5.2/src/commands/manifest.ts)_

docs/pack.md

@@ -0,0 +1,109 @@
+# `oclif pack`
+
+package an oclif CLI into installable artifacts
+
+- [`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 pack deb`
+
+Pack CLI into debian package.
+
+```
+USAGE
+  $ oclif pack deb -r <value> [-z gzip|none|xz|zstd] [-t <value>]
+
+FLAGS
+  -r, --root=<value>          (required) [default: .] Path to oclif CLI root.
+  -t, --tarball=<value>       Optionally specify a path to a tarball already generated by NPM.
+  -z, --compression=<option>  Override the default compression used by dpkg-deb.
+                              <options: gzip|none|xz|zstd>
+
+DESCRIPTION
+  Pack CLI into debian package.
+
+FLAG DESCRIPTIONS
+  -z, --compression=gzip|none|xz|zstd  Override the default compression used by dpkg-deb.
+
+    For more details see the `-Zcompress-type` section at https://man7.org/linux/man-pages/man1/dpkg-deb.1.html
+```
+
+_See code: [src/commands/pack/deb.ts](https://github.com/oclif/oclif/blob/v4.5.2/src/commands/pack/deb.ts)_
+
+## `oclif pack macos`
+
+pack CLI into macOS .pkg
+
+```
+USAGE
+  $ oclif pack macos -r <value> [-t <value>] [--targets <value>]
+
+FLAGS
+  -r, --root=<value>     (required) [default: .] path to oclif CLI root
+  -t, --tarball=<value>  optionally specify a path to a tarball already generated by NPM
+      --targets=<value>  comma-separated targets to pack (e.g.: darwin-x64,darwin-arm64)
+
+DESCRIPTION
+  pack CLI into macOS .pkg
+```
+
+_See code: [src/commands/pack/macos.ts](https://github.com/oclif/oclif/blob/v4.5.2/src/commands/pack/macos.ts)_
+
+## `oclif pack tarballs`
+
+packages oclif CLI into tarballs
+
+```
+USAGE
+  $ oclif pack tarballs -r <value> [--parallel] [-l <value>] [-t <value>] [--xz]
+
+FLAGS
+  -l, --tarball=<value>  optionally specify a path to a tarball already generated by NPM
+  -r, --root=<value>     (required) [default: .] path to oclif CLI root
+  -t, --targets=<value>  comma-separated targets to pack (e.g.: linux-arm,win32-x64)
+      --parallel         build tarballs in parallel
+      --[no-]xz          also build xz
+
+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.
+```
+
+_See code: [src/commands/pack/tarballs.ts](https://github.com/oclif/oclif/blob/v4.5.2/src/commands/pack/tarballs.ts)_
+
+## `oclif pack win`
+
+create windows installer from oclif CLI
+
+```
+USAGE
+  $ oclif pack win -r <value> [--defender-exclusion checked|unchecked|hidden] [-t <value>] [--targets <value>]
+
+FLAGS
+  -r, --root=<value>                 (required) [default: .] path to oclif CLI root
+  -t, --tarball=<value>              optionally specify a path to a tarball already generated by NPM
+      --defender-exclusion=<option>  [default: checked] set to "checked" or "unchecked" to set the default value for the
+                                     checkbox.  Set to "hidden" to hide the option (will let defender do its thing)
+                                     <options: checked|unchecked|hidden>
+      --targets=<value>              comma-separated targets to pack (e.g.: win32-x64,win32-x86)
+
+DESCRIPTION
+  create windows installer from oclif CLI
+
+  This command will produce unsigned installers unless you supply WINDOWS_SIGNING_PASS (prefixed with the name of your
+  executable, e.g. OCLIF_WINDOWS_SIGNING_PASS) in the environment and have set the windows.name and windows.keypath
+  properties in your package.json's oclif property.
+
+FLAG DESCRIPTIONS
+  --defender-exclusion=checked|unchecked|hidden
+
+    set to "checked" or "unchecked" to set the default value for the checkbox.  Set to "hidden" to hide the option (will
+    let defender do its thing)
+
+    there is no way to set a hidden checkbox with "true" as a default...the user can always allow full security
+```
+
+_See code: [src/commands/pack/win.ts](https://github.com/oclif/oclif/blob/v4.5.2/src/commands/pack/win.ts)_

docs/promote.md

@@ -0,0 +1,33 @@
+# `oclif promote`
+
+promote CLI builds to a S3 release channel
+
+- [`oclif promote`](#oclif-promote)
+
+## `oclif promote`
+
+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
+
+DESCRIPTION
+  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)_

docs/readme.md

@@ -0,0 +1,54 @@
+# `oclif readme`
+
+adds commands to README.md in current directory
+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 -->
+
+# Table of contents
+
+<!-- toc -->
+
+Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
+
+- [`oclif readme`](#oclif-readme)
+
+## `oclif readme`
+
+adds commands to README.md in current directory
+
+```
+USAGE
+  $ oclif readme --output-dir <value> ---path <value> [--aliases] [--nested-topics-depth <value> --multi]
+    [--plugin-directory <value>] [--repository-prefix <value>] [--version <value>]
+
+FLAGS
+  --[no-]aliases                 Include aliases in the command list.
+  --multi                        Create a different markdown page for each topic.
+  --nested-topics-depth=<value>  Max nested topics depth for multi markdown page generation. Use with --multi enabled.
+  --output-dir=<value>           (required) [default: docs] Output directory for multi docs.
+  --plugin-directory=<value>     Plugin directory to generate README for. Defaults to the current directory.
+  --readme-path=<value>          (required) [default: README.md] Path to the README file.
+  --repository-prefix=<value>    A template string used to build links to the source code.
+  --version=<value>              Version to use in readme links. Defaults to the version in package.json.
+
+DESCRIPTION
+  adds commands to README.md in current directory
+  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 -->
+  # Table of contents
+  <!-- toc -->
+
+  Customize the code URL prefix by setting oclif.repositoryPrefix in package.json.
+```
+
+_See code: [src/commands/readme.ts](https://github.com/oclif/oclif/blob/v4.5.2/src/commands/readme.ts)_