TITLE: Install and Basic Usage of ccc-deploy CLI DESCRIPTION: This snippet demonstrates how to install the `ccc-deploy` CLI globally using npm and provides examples of basic command execution, version checking, and accessing help. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_0 LANGUAGE: sh CODE: ``` $ npm install -g ccc-deploy $ ccc-deploy COMMAND running command... $ ccc-deploy (--version) ccc-deploy/0.0.0 linux-x64 node-v20.17.0 $ ccc-deploy --help [COMMAND] USAGE $ ccc-deploy COMMAND ... ``` ---------------------------------------- TITLE: ccc-deploy help [COMMAND] Command Reference DESCRIPTION: Documentation for the `ccc-deploy help` command, used to display help information for the CLI or specific commands. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_3 LANGUAGE: APIDOC CODE: ``` USAGE $ ccc-deploy 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 ccc-deploy. ``` ---------------------------------------- TITLE: Install ccc-deploy CLI Plugin DESCRIPTION: Installs a plugin into ccc-deploy using npm. This command supports installing plugins from npm registry, GitHub URLs, or GitHub slugs. User-installed plugins override core plugins. npm behavior can be configured via environment variables CCC_DEPLOY_NPM_LOG_LEVEL and CCC_DEPLOY_NPM_REGISTRY. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_7 LANGUAGE: APIDOC CODE: ``` USAGE $ ccc-deploy 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 ccc-deploy. Uses npm to install plugins. Installation of a user-installed plugin will override a core plugin. Use the CCC_DEPLOY_NPM_LOG_LEVEL environment variable to set the npm loglevel. Use the CCC_DEPLOY_NPM_REGISTRY environment variable to set the npm registry. ALIASES $ ccc-deploy plugins add EXAMPLES Install a plugin from npm registry. $ ccc-deploy plugins install myplugin Install a plugin from a github url. $ ccc-deploy plugins install https://github.com/someuser/someplugin Install a plugin from a github slug. $ ccc-deploy plugins install someuser/someplugin ``` ---------------------------------------- TITLE: ccc-deploy plugins add PLUGIN Command Reference DESCRIPTION: Documentation for the `ccc-deploy plugins add` command, used to install new plugins into the `ccc-deploy` CLI from npm or a GitHub URL/slug. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_5 LANGUAGE: APIDOC CODE: ``` USAGE $ ccc-deploy 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 ccc-deploy. Uses npm to install plugins. Installation of a user-installed plugin will override a core plugin. Use the CCC_DEPLOY_NPM_LOG_LEVEL environment variable to set the npm loglevel. Use the CCC_DEPLOY_NPM_REGISTRY environment variable to set the npm registry. ALIASES $ ccc-deploy plugins add EXAMPLES Install a plugin from npm registry. $ ccc-deploy plugins add myplugin Install a plugin from a github url. $ ccc-deploy plugins add https://github.com/someuser/someplugin Install a plugin from a github slug. $ ccc-deploy plugins add someuser/someplugin ``` ---------------------------------------- TITLE: Update ccc-deploy CLI Plugins DESCRIPTION: Updates all currently installed plugins for the ccc-deploy CLI. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_13 LANGUAGE: APIDOC CODE: ``` USAGE $ ccc-deploy plugins update [-h] [-v] FLAGS -h, --help Show CLI help. -v, --verbose DESCRIPTION Update installed plugins. ``` ---------------------------------------- TITLE: ccc-deploy plugins Command Reference DESCRIPTION: Documentation for the `ccc-deploy plugins` command, which lists all installed plugins, with options to show core plugins or format output as JSON. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_4 LANGUAGE: APIDOC CODE: ``` USAGE $ ccc-deploy plugins [--json] [--core] FLAGS --core Show core plugins. GLOBAL FLAGS --json Format output as json. DESCRIPTION List installed plugins. EXAMPLES $ ccc-deploy plugins ``` ---------------------------------------- TITLE: Uninstall ccc-deploy CLI Plugin DESCRIPTION: Removes one or more specified plugins from the ccc-deploy CLI. This command is an alias for `remove` and `unlink`. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_11 LANGUAGE: APIDOC CODE: ``` USAGE $ ccc-deploy 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 $ ccc-deploy plugins unlink $ ccc-deploy plugins remove EXAMPLES $ ccc-deploy plugins uninstall myplugin ``` ---------------------------------------- TITLE: Remove ccc-deploy CLI Plugin DESCRIPTION: Removes one or more specified plugins from the ccc-deploy CLI. This command is an alias for `uninstall` and `unlink`. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_9 LANGUAGE: APIDOC CODE: ``` USAGE $ ccc-deploy 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 $ ccc-deploy plugins unlink $ ccc-deploy plugins remove EXAMPLES $ ccc-deploy plugins remove myplugin ``` ---------------------------------------- TITLE: Link ccc-deploy CLI Plugin for Development DESCRIPTION: Links a local plugin into the CLI for development purposes. This allows developers to test local plugin changes directly within the CLI. A linked plugin will override user-installed or core plugins with the same commands, facilitating development and testing. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_8 LANGUAGE: APIDOC CODE: ``` USAGE $ ccc-deploy 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 $ ccc-deploy plugins link myplugin ``` ---------------------------------------- TITLE: ccc-deploy plugins inspect PLUGIN Command Reference DESCRIPTION: Documentation for the `ccc-deploy plugins inspect` command, which displays installation properties of a specified plugin. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_6 LANGUAGE: APIDOC CODE: ``` USAGE $ ccc-deploy 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 $ ccc-deploy plugins inspect myplugin ``` ---------------------------------------- TITLE: Reset ccc-deploy CLI Plugins DESCRIPTION: Removes all user-installed and linked plugins from the ccc-deploy CLI. The `--hard` flag also deletes `node_modules` and package manager related files, while `--reinstall` reinstalls all plugins after uninstallation. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_10 LANGUAGE: APIDOC CODE: ``` USAGE $ ccc-deploy 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. ``` ---------------------------------------- TITLE: Unlink ccc-deploy CLI Plugin DESCRIPTION: Removes one or more specified plugins from the ccc-deploy CLI. This command is an alias for `remove` and `uninstall`. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_12 LANGUAGE: APIDOC CODE: ``` USAGE $ ccc-deploy 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 $ ccc-deploy plugins unlink $ ccc-deploy plugins remove EXAMPLES $ ccc-deploy plugins unlink myplugin ``` ---------------------------------------- TITLE: ccc-deploy hello PERSON Command Reference DESCRIPTION: Documentation for the `ccc-deploy hello PERSON` command, which allows saying hello to a specified person with a required 'from' flag. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_1 LANGUAGE: APIDOC CODE: ``` USAGE $ ccc-deploy hello PERSON -f ARGUMENTS PERSON Person to say hello to FLAGS -f, --from= (required) Who is saying hello DESCRIPTION Say hello EXAMPLES $ ccc-deploy hello friend --from oclif hello friend from oclif! (./src/commands/hello/index.ts) ``` ---------------------------------------- TITLE: ccc-deploy hello world Command Reference DESCRIPTION: Documentation for the `ccc-deploy hello world` command, a simple command to output 'hello world!'. SOURCE: https://github.com/ckb-devrel/ccc-deploy/blob/0.0.1-alpha-dev/README.md#_snippet_2 LANGUAGE: APIDOC CODE: ``` USAGE $ ccc-deploy hello world DESCRIPTION Say hello world EXAMPLES $ ccc-deploy hello world hello world! (./src/commands/hello/world.ts) ```