Skip to content

README.md

Latest commit

 

History

History
499 lines (344 loc) · 11.1 KB

README.md

File metadata and controls

499 lines (344 loc) · 11.1 KB

oclif-hello-world

oclif example Hello World CLI

oclif CircleCI GitHub license

Usage

$ npm install -g codify
$ codify COMMAND
running command...
$ codify (--version)
codify/0.0.4 darwin-arm64 node-v20.15.0
$ codify --help [COMMAND]
USAGE
  $ codify COMMAND
...

Commands

codify apply

Apply a codify.json file. Codify apply will first generate a plan of the changes needed to meet the desired config in the codify.json file. The user will have the option to then apply the plan.

USAGE
  $ codify apply [--json] [--debug] [-o plain|default|debug|json] [-s] [-p <value>]

FLAGS
  -o, --output=<option>  [default: default]
                         <options: plain|default|debug|json>
  -p, --path=<value>     path to project
  -s, --secure
  --debug

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Apply a codify.json file. Codify apply will first generate a plan of the changes needed to meet the desired config in
  the codify.json file. The user will have the option to then apply the plan.

EXAMPLES
  $ codify apply

codify autocomplete [SHELL]

Display autocomplete installation instructions.

USAGE
  $ codify autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  (zsh|bash|powershell) Shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  Display autocomplete installation instructions.

EXAMPLES
  $ codify autocomplete

  $ codify autocomplete bash

  $ codify autocomplete zsh

  $ codify autocomplete powershell

  $ codify autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

codify help [COMMAND]

Display help for codify.

USAGE
  $ codify help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for codify.

See code: @oclif/plugin-help

codify plan

Generate a plan based on a codify.json file. This plan will list out the changes Codify will need to make in order to meet the desired config.

USAGE
  $ codify plan [--json] [--debug] [-o plain|default|debug|json] [-s] [-p <value>]

FLAGS
  -o, --output=<option>  [default: default]
                         <options: plain|default|debug|json>
  -p, --path=<value>     path to project
  -s, --secure
  --debug

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Generate a plan based on a codify.json file. This plan will list out the changes Codify will need to make in order to
  meet the desired config.

EXAMPLES
  $ codify plan

codify plugins

List installed plugins.

USAGE
  $ codify plugins [--json] [--core]

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ codify plugins

See code: @oclif/plugin-plugins

codify plugins add PLUGIN

Installs a plugin into codify.

USAGE
  $ codify plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into codify.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the CODIFY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the CODIFY_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ codify plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ codify plugins add myplugin

  Install a plugin from a github url.

    $ codify plugins add https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ codify plugins add someuser/someplugin

codify plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ codify plugins inspect PLUGIN...

ARGUMENTS
  PLUGIN...  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ codify plugins inspect myplugin

See code: @oclif/plugin-plugins

codify plugins install PLUGIN

Installs a plugin into codify.

USAGE
  $ codify plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]

ARGUMENTS
  PLUGIN...  Plugin to install.

FLAGS
  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
  -h, --help     Show CLI help.
  -s, --silent   Silences npm output.
  -v, --verbose  Show verbose npm output.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Installs a plugin into codify.

  Uses npm to install plugins.

  Installation of a user-installed plugin will override a core plugin.

  Use the CODIFY_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the CODIFY_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ codify plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ codify plugins install myplugin

  Install a plugin from a github url.

    $ codify plugins install https://github.com/someuser/someplugin

  Install a plugin from a github slug.

    $ codify plugins install someuser/someplugin

See code: @oclif/plugin-plugins

codify plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ codify plugins link PATH [-h] [--install] [-v]

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help          Show CLI help.
  -v, --verbose
      --[no-]install  Install dependencies after linking the plugin.

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ codify plugins link myplugin

See code: @oclif/plugin-plugins

codify plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ codify plugins remove [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ codify plugins unlink
  $ codify plugins remove

EXAMPLES
  $ codify plugins remove myplugin

codify plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ codify plugins reset [--hard] [--reinstall]

FLAGS
  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
  --reinstall  Reinstall all plugins after uninstalling.

See code: @oclif/plugin-plugins

codify plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ codify plugins uninstall [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ codify plugins unlink
  $ codify plugins remove

EXAMPLES
  $ codify plugins uninstall myplugin

See code: @oclif/plugin-plugins

codify plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ codify plugins unlink [PLUGIN...] [-h] [-v]

ARGUMENTS
  PLUGIN...  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ codify plugins unlink
  $ codify plugins remove

EXAMPLES
  $ codify plugins unlink myplugin

codify plugins update

Update installed plugins.

USAGE
  $ codify plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins

codify uninstall

Uninstall a given resource based on id.

USAGE
  $ codify uninstall [--json] [--debug] [-o plain|default|debug|json] [-s]

FLAGS
  -o, --output=<option>  [default: default]
                         <options: plain|default|debug|json>
  -s, --secure
  --debug

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Uninstall a given resource based on id.

EXAMPLES
  $ codify uninstall

codify update [CHANNEL]

update the codify CLI

USAGE
  $ codify update [CHANNEL] [--force |  | [-a | -v <value> | -i]]

FLAGS
  -a, --available        See available versions.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
      --force            Force a re-download of the requested version.

DESCRIPTION
  update the codify CLI

EXAMPLES
  Update to the stable channel:

    $ codify update stable

  Update to a specific version:

    $ codify update --version 1.0.0

  Interactively select version:

    $ codify update --interactive

  See available versions:

    $ codify update --available

See code: @oclif/plugin-update