coveops-cli-plugin v0.3.0

coveops-cli-plugin

A new CLI generated with oclif

• Usage
• Commands

Usage

$ npm install -g coveops-cli-plugin
$ coveops COMMAND
running command...
$ coveops (--version)
coveops-cli-plugin/0.3.0 darwin-arm64 node-v20.16.0
$ coveops --help [COMMAND]
USAGE
  $ coveops COMMAND
...

Commands

• coveops hello PERSON
• coveops hello world
• coveops help [COMMAND]
• coveops org search authentication create NAME
• coveops org search authentication delete ID
• coveops org search authentication list
• coveops org search authentication update ID
• coveops org vaults create
• coveops org vaults list
• coveops plugins
• coveops plugins add PLUGIN
• coveops plugins:inspect PLUGIN...
• coveops plugins install PLUGIN
• coveops plugins link PATH
• coveops plugins remove [PLUGIN]
• coveops plugins reset
• coveops plugins uninstall [PLUGIN]
• coveops plugins unlink [PLUGIN]
• coveops plugins update

coveops hello PERSON

Say hello

USAGE
  $ coveops hello PERSON -f <value>

ARGUMENTS
  PERSON  Person to say hello to

FLAGS
  -f, --from=<value>  (required) Who is saying hello

DESCRIPTION
  Say hello

EXAMPLES
  $ coveops hello friend --from oclif
  hello friend from oclif! (./src/commands/hello/index.ts)

See code: src/commands/hello/index.ts

coveops hello world

Say hello world

USAGE
  $ coveops hello world

DESCRIPTION
  Say hello world

EXAMPLES
  $ coveops hello world
  hello world! (./src/commands/hello/world.ts)

See code: src/commands/hello/world.ts

coveops help [COMMAND]

Display help for coveops.

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

See code: @oclif/plugin-help

coveops org search authentication create NAME

Create a new Authentication provider (SAML or Sharepoint Claims) in the specified organization

USAGE
  $ coveops org search authentication create NAME -r <value> [-a <value>] [-f] [-e <value>] [-m <value>] [-p <value>] [-s <value>] [-t
    saml|sharepoint] [-u <value>]

ARGUMENTS
  NAME  Name for the authentication provider

FLAGS
  -a, --assertionConsumerServiceUrl=<value>  Assertion Consumer Service URL for the authentication provider
  -e, --expiration=<value>                   Expiration time for the authentication provider
  -f, --enforceTrustedUris                   Enforce trusted URIs
  -m, --metadataUrl=<value>                  Metadata URL for the authentication provider
  -p, --provider=<value>                     [default: Email Security Provider] Desired Security Provider for the
                                             authentication provider
  -r, --relyingPartyIdentifier=<value>       (required) [default: https://platform.cloud.coveo.com] Relying Party
                                             Identifier for the authentication provider
  -s, --secret=<value>                       Secret for the authentication provider
  -t, --type=<option>                        [default: saml] Type of authentication provider to list
                                             <options: saml|sharepoint>
  -u, --uri=<value>                          URI for the Sharepoint Claims authentication provider

DESCRIPTION
  Create a new Authentication provider (SAML or Sharepoint Claims) in the specified organization

EXAMPLES
  $ coveops org search authentication create --type saml "My SAML Provider" --metadataUrl "https://example.com/metadata.xml"

See code: src/commands/org/search/authentication/create.ts

coveops org search authentication delete ID

Deletes an existing Authentication provider (SAML or Sharepoint Claims) in the specified organization

USAGE
  $ coveops org search authentication delete ID [-t saml|sharepoint]

ARGUMENTS
  ID  Id of the authentication provider to delete

FLAGS
  -t, --type=<option>  Type of authentication provider to list
                       <options: saml|sharepoint>

DESCRIPTION
  Deletes an existing Authentication provider (SAML or Sharepoint Claims) in the specified organization

EXAMPLES
  $ coveops org search authentication delete 73404dc5-1111-1111-1111-0e5144482521

See code: src/commands/org/search/authentication/delete.ts

coveops org search authentication list

List all authentication providers for an organization

USAGE
  $ coveops org search authentication list [--json] [-f] [-t saml|sharepoint]

FLAGS
  -f, --force
  -t, --type=<option>  Type of authentication provider to list
                       <options: saml|sharepoint>

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List all authentication providers for an organization

EXAMPLES
  $ coveops org search authentication list

See code: src/commands/org/search/authentication/list.ts

coveops org search authentication update ID

Updates an existing Authentication provider (SAML or Sharepoint Claims) in the specified organization

USAGE
  $ coveops org search authentication update ID -n <value> -r <value> [-a <value>] [-f] [-e <value>] [-m <value>] [-p <value>] [-s
    <value>] [-t saml|sharepoint] [-u <value>]

ARGUMENTS
  ID  Id of the authentication provider to update

FLAGS
  -a, --assertionConsumerServiceUrl=<value>  Assertion Consumer Service URL for the authentication provider
  -e, --expiration=<value>                   Expiration time for the authentication provider
  -f, --enforceTrustedUris                   Enforce trusted URIs
  -m, --metadataUrl=<value>                  Metadata URL for the authentication provider
  -n, --name=<value>                         (required) Name of the authentication provider
  -p, --provider=<value>                     [default: Email Security Provider] Desired Security Provider for the
                                             authentication provider
  -r, --relyingPartyIdentifier=<value>       (required) [default: https://platform.cloud.coveo.com] Relying Party
                                             Identifier for the authentication provider
  -s, --secret=<value>                       Secret for the authentication provider
  -t, --type=<option>                        [default: saml] Type of authentication provider to list
                                             <options: saml|sharepoint>
  -u, --uri=<value>                          URI for the Sharepoint Claims authentication provider

DESCRIPTION
  Updates an existing Authentication provider (SAML or Sharepoint Claims) in the specified organization

EXAMPLES
  $ coveops org search authentication update --type saml 73404dc5-1111-1111-1111-0e5144482521 --relyingPartyIdentifier https://platform-ca.cloud.coveo.com

See code: src/commands/org/search/authentication/update.ts

coveops org vaults create

Create a new Vault parameter in the specified organization

USAGE
  $ coveops org vaults create -n <value> -v <value> [-r EXTENSION|SOURCE -s <value>...] [-t PUBLIC|OBFUSCATED|STRICT]

FLAGS
  -n, --key=<value>            (required) Key for the Vault parameter
  -r, --resourceType=<option>  [default: EXTENSION] Resource type for Scope of the Vault parameter
                               <options: EXTENSION|SOURCE>
  -s, --scope=<value>...       Scope for the Vault parameter
  -t, --visibility=<option>    [default: OBFUSCATED] Visibility type (PUBLIC, OBFUSCATED, or STRICT)
                               <options: PUBLIC|OBFUSCATED|STRICT>
  -v, --value=<value>          (required) Value for the Vault parameter

DESCRIPTION
  Create a new Vault parameter in the specified organization

See code: src/commands/org/vaults/create.ts

coveops org vaults list

List all Vault parameters in the specified organization

USAGE
  $ coveops org vaults list [--json]

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List all Vault parameters in the specified organization

EXAMPLES
  coveo org:vaults:list

See code: src/commands/org/vaults/list.ts

coveops plugins

List installed plugins.

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

FLAGS
  --core  Show core plugins.

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ coveops plugins

See code: @oclif/plugin-plugins

coveops plugins add PLUGIN

Installs a plugin into coveops.

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

  Uses npm to install plugins.

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

  Use the COVEOPS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the COVEOPS_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ coveops plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ coveops plugins add myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ coveops plugins add someuser/someplugin

coveops plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ coveops 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
  $ coveops plugins inspect myplugin

See code: @oclif/plugin-plugins

coveops plugins install PLUGIN

Installs a plugin into coveops.

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

  Uses npm to install plugins.

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

  Use the COVEOPS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
  Use the COVEOPS_NPM_REGISTRY environment variable to set the npm registry.

ALIASES
  $ coveops plugins add

EXAMPLES
  Install a plugin from npm registry.

    $ coveops plugins install myplugin

  Install a plugin from a github url.

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

  Install a plugin from a github slug.

    $ coveops plugins install someuser/someplugin

See code: @oclif/plugin-plugins

coveops plugins link PATH

Links a plugin into the CLI for development.

USAGE
  $ coveops 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
  $ coveops plugins link myplugin

See code: @oclif/plugin-plugins

coveops plugins remove [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ coveops 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
  $ coveops plugins unlink
  $ coveops plugins remove

EXAMPLES
  $ coveops plugins remove myplugin

coveops plugins reset

Remove all user-installed and linked plugins.

USAGE
  $ coveops 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

coveops plugins uninstall [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ coveops 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
  $ coveops plugins unlink
  $ coveops plugins remove

EXAMPLES
  $ coveops plugins uninstall myplugin

See code: @oclif/plugin-plugins

coveops plugins unlink [PLUGIN]

Removes a plugin from the CLI.

USAGE
  $ coveops 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
  $ coveops plugins unlink
  $ coveops plugins remove

EXAMPLES
  $ coveops plugins unlink myplugin

coveops plugins update

Update installed plugins.

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

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

DESCRIPTION
  Update installed plugins.

See code: @oclif/plugin-plugins