@clipdrop/cli

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g @clipdrop/cli
$ clipdrop COMMAND
running command...
$ clipdrop (--version)
@clipdrop/cli/0.1.6 linux-x64 node-v16.17.0
$ clipdrop --help [COMMAND]
USAGE
  $ clipdrop COMMAND
...

Commands

• clipdrop cleanup
• clipdrop completion
• clipdrop completion generate
• clipdrop completion generate alias ALIAS
• clipdrop help [COMMAND]
• clipdrop plugins
• clipdrop plugins:install PLUGIN...
• clipdrop plugins:inspect PLUGIN...
• clipdrop plugins:install PLUGIN...
• clipdrop plugins:link PLUGIN
• clipdrop plugins:uninstall PLUGIN...
• clipdrop plugins:uninstall PLUGIN...
• clipdrop plugins:uninstall PLUGIN...
• clipdrop plugins update
• clipdrop register-api-key KEY
• clipdrop remove-background
• clipdrop super-resolution

clipdrop cleanup

Remove objects on a picture

USAGE
  $ clipdrop cleanup -i <value> [--object <value>] [-m <value>] [-f <value> | -o <value>]

FLAGS
  -f, --folder=<value>     Result destination folder, can be useFull with multi process
  -i, --image=<value>...   (required) Image to process can be glob pattern like "/path/to/image/*.jpg"
  -m, --mask=<value>       Related mask
  -o, --output=<value>...  Result destination
  --object=<value>...      [required for batch] object to remove in all pictures, detected with cocoSsd model. Use "*"
                           to remove all detected objects

DESCRIPTION
  Remove objects on a picture

EXAMPLES
  $ clipdrop cleanup

See code: dist/commands/cleanup.ts

clipdrop completion

Generate shell completion script

USAGE
  $ clipdrop completion -s bash|fish|zsh

FLAGS
  -s, --shell=<option>  (required) Name of shell
                        <options: bash|fish|zsh>

DESCRIPTION
  Generate shell completion script

  Run this command to see instructions for your shell.

EXAMPLES
  $ clipdrop completion --shell zsh

See code: oclif-plugin-completion

clipdrop completion generate

Generates completion script

USAGE
  $ clipdrop completion generate -s bash|fish|zsh

FLAGS
  -s, --shell=<option>  (required) Name of shell
                        <options: bash|fish|zsh>

DESCRIPTION
  Generates completion script

  Run the "completion" command to see instructions about how to use the script generated by this command.

EXAMPLES
  $ clipdrop completion:generate --shell zsh

clipdrop completion generate alias ALIAS

Generates completion script for alias

USAGE
  $ clipdrop completion generate alias [ALIAS] -s bash|fish

ARGUMENTS
  ALIAS  name of the alias

FLAGS
  -s, --shell=<option>  (required) Name of shell
                        <options: bash|fish>

DESCRIPTION
  Generates completion script for alias

  This needs the completion script for the main command to be present.

  Check the "completion:generate" command.

clipdrop help [COMMAND]

Display help for clipdrop.

USAGE
  $ clipdrop 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 clipdrop.

See code: @oclif/plugin-help

clipdrop plugins

List installed plugins.

USAGE
  $ clipdrop plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ clipdrop plugins

See code: @oclif/plugin-plugins

clipdrop plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ clipdrop plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

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

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ clipdrop plugins add

EXAMPLES
  $ clipdrop plugins:install myplugin 

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

  $ clipdrop plugins:install someuser/someplugin

clipdrop plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ clipdrop plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

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

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ clipdrop plugins:inspect myplugin

clipdrop plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ clipdrop plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.

  Can be installed from npm or a git url.

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

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ clipdrop plugins add

EXAMPLES
  $ clipdrop plugins:install myplugin 

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

  $ clipdrop plugins:install someuser/someplugin

clipdrop plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ clipdrop plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

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

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
  $ clipdrop plugins:link myplugin

clipdrop plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ clipdrop plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ clipdrop plugins unlink
  $ clipdrop plugins remove

clipdrop plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ clipdrop plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ clipdrop plugins unlink
  $ clipdrop plugins remove

clipdrop plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ clipdrop plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ clipdrop plugins unlink
  $ clipdrop plugins remove

clipdrop plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

clipdrop register-api-key KEY

Register the ClipDrop API key

USAGE
  $ clipdrop register-api-key [KEY]

ARGUMENTS
  KEY  API token to register

DESCRIPTION
  Register the ClipDrop API key

EXAMPLES
  $ clipdrop register-api-key <key>

See code: dist/commands/register-api-key.ts

clipdrop remove-background

Remove the background of a picture

USAGE
  $ clipdrop remove-background -i <value> [-f <value> | -o <value>]

FLAGS
  -f, --folder=<value>     Result destination folder, can be useFull with multi process
  -i, --image=<value>...   (required) Image to process can be glob pattern like "/path/to/image/*.jpg"
  -o, --output=<value>...  Result destination

DESCRIPTION
  Remove the background of a picture

EXAMPLES
  $ clipdrop remove-background

See code: dist/commands/remove-background.ts

clipdrop super-resolution

Upscale the resolution of a picture

USAGE
  $ clipdrop super-resolution -i <value> [-s 2|4] [-f <value> | -o <value>]

FLAGS
  -f, --folder=<value>     Result destination folder, can be useFull with multi process
  -i, --image=<value>...   (required) Image to process can be glob pattern like "/path/to/image/*.jpg"
  -o, --output=<value>...  Result destination
  -s, --scale=(2|4)        [default: 2] Scale applied to your picture

DESCRIPTION
  Upscale the resolution of a picture

EXAMPLES
  $ clipdrop super-resolution

See code: dist/commands/super-resolution.ts