diff --git a/docs/generate.md b/docs/generate.md new file mode 100644 index 000000000..1544798d5 --- /dev/null +++ b/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 ] [--force] + +ARGUMENTS + NAME name of hook (snake_case) + +FLAGS + --event= [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)_ diff --git a/docs/help.md b/docs/help.md new file mode 100644 index 000000000..e6ae20561 --- /dev/null +++ b/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)_ diff --git a/docs/manifest.md b/docs/manifest.md new file mode 100644 index 000000000..36e5a571f --- /dev/null +++ b/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)_ diff --git a/docs/pack.md b/docs/pack.md new file mode 100644 index 000000000..7b0c40876 --- /dev/null +++ b/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 [-z gzip|none|xz|zstd] [-t ] + +FLAGS + -r, --root= (required) [default: .] Path to oclif CLI root. + -t, --tarball= Optionally specify a path to a tarball already generated by NPM. + -z, --compression=