@coveo/cli v3.2.4

@coveo/cli

• @coveo/cli
• Usage
• Commands

Usage

$ npm install -g @coveo/cli
$ coveo COMMAND
running command...
$ coveo (-v|--version|version)
@coveo/cli/1.17.1-alpha.1 win32-x64 node-v16.12.0
$ coveo --help [COMMAND]
USAGE
  $ coveo COMMAND
...

Commands

• coveo auth:login
• coveo auth:token
• coveo config:get
• coveo config:set
• coveo help [COMMAND]
• coveo org:list
• coveo org:search:dump
• coveo source:push:add SOURCEID
• coveo source:push:delete SOURCEID
• coveo source:push:list
• coveo source:push:new NAME
• coveo ui:create:angular NAME
• coveo ui:create:react NAME
• coveo ui:create:vue NAME
• coveo update [CHANNEL]

coveo auth:login

Log in to the Coveo Platform using the OAuth2 flow.

USAGE
  $ coveo auth:login

OPTIONS
  -e, --environment=dev|qa|hipaa|prod  [default: prod] The Coveo Platform environment to log in to.

  -o, --organization=myOrgID           The identifier of the organization to log in to. If not specified, the CLI logs
                                       you in to the first available organization. See also commands `config:get`,
                                       `config:set`, and `org:list`.

  -r, --region=US|EU|AU                [default: us] The Coveo Platform region to log in to. See
                                       <https://docs.coveo.com/en/2976>.

EXAMPLE
  $ coveo auth:login

See code: src/commands/auth/login.ts

coveo auth:token

Log in to the Coveo Platform using the OAuth2 flow.

USAGE
  $ coveo auth:token

OPTIONS
  -e, --environment=dev|qa|hipaa|prod  [default: prod] The Coveo Platform environment to log in to.

  -r, --region=US|EU|AU                [default: us] The Coveo Platform region to log in to. See
                                       <https://docs.coveo.com/en/2976>.

  -t, --token=xxx-api-key              (required) The API-Key that shall be used to authenticate you to the
                                       organization. See
                                       <https://github.com/coveo/cli/wiki/Using-the-CLI-using-an-API-Key>.

EXAMPLE
  $ coveo auth:token

See code: src/commands/auth/token.ts

coveo config:get

Display the current configuration.

USAGE
  $ coveo config:get

See code: src/commands/config/get.ts

coveo config:set

Modify the current configuration.

USAGE
  $ coveo config:set

OPTIONS
  -a, --analytics=y|n                  Whether to enable analytics and telemetry tracking.
  -e, --environment=dev|qa|hipaa|prod  The Coveo Platform environment to log in to.

  -o, --organization=myOrgID           The identifier of the organization inside which to perform operations. See
                                       <https://docs.coveo.com/en/1562/#organization-id-and-other-information>.

  -r, --region=US|EU|AU                The Coveo Platform region to log in to. See <https://docs.coveo.com/en/2976>.

See code: src/commands/config/set.ts

coveo help [COMMAND]

display help for coveo

USAGE
  $ coveo help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

coveo org:list

List Coveo organizations.

USAGE
  $ coveo org:list

OPTIONS
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

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

coveo org:search:dump

Dump the content of one or more sources in CSV format.

USAGE
  $ coveo org:search:dump

OPTIONS
  -c, --chunkSize=chunkSize                [default: 10000] The maximum number of results to dump into each CSV file.

  -d, --destination=destination            [default: .] The folder in which to create the CSV files. The data dump will
                                           fail if the folder doesn't exist.

  -f, --additionalFilter=additionalFilter  The additional search filter to apply while getting the content. See
                                           <https://docs.coveo.com/en/1552>.

  -n, --name=name                          [default: indexdump] The base name to use when creating a new CSV file. If
                                           more than one file is created, the CLI will append `_2`, `_3`, etc. to each
                                           new file name after the first one.

  -p, --pipeline=pipeline                  The name of the query pipeline through which to get content. If not
                                           specified, the default query pipeline is used.

  -s, --source=mySourceName                (required) The names (not the identifiers) of the sources from which to get
                                           content.

  -x, --fieldsToExclude=fieldsToExclude    The fields to exclude from the data dump. If not specified, all fields are
                                           included.

See code: src/commands/org/search/dump.ts

coveo source:push:add SOURCEID

Push a JSON document into a Coveo Push source. See https://github.com/coveo/cli/wiki/Pushing-JSON-files-with-Coveo-CLI for more information.

USAGE
  $ coveo source:push:add SOURCEID

ARGUMENTS
  SOURCEID  The identifier of the source on which to perform the add operation. See source:push:list to obtain the
            identifier.

OPTIONS
  -d, --folder=./my_folder_with_multiple_json_files  One or multiple folder containing json files. Can be repeated
  -f, --file=myfile.json                             One or multiple file to push. Can be repeated.

See code: src/commands/source/push/add.ts

coveo source:push:delete SOURCEID

Delete one or multiple items in a given Push source. See https://docs.coveo.com/en/171 and https://docs.coveo.com/en/131

USAGE
  $ coveo source:push:delete SOURCEID

ARGUMENTS
  SOURCEID  The identifier of the Push source on which to perform the delete operation. To retrieve the list of
            available Push source identifiers, use the `source:push:list` command.

OPTIONS
  -c, --deleteChildren
      Whether to delete all items that share the same base URI as the specified item to delete.

  -d, --deleteOlderThan=2000-01-01T00:00:00-06:00 OR 946702800
      If this flag is set, all items that have been added or updated in the source before the specified ISO 8601 date or 
      Unix timestamp will be deleted. The documents will be deleted using the default queueDelay, meaning they will stay 
      in the index for about 15 minutes after being marked for deletion.

  -x, --delete=delete
      The URIs of the items to delete. Can be repeated. If you want to delete more than one specific items, use the 
      `source:push:batch` command instead.

See code: src/commands/source/push/delete.ts

coveo source:push:list

List all available push sources in your Coveo organization

USAGE
  $ coveo source:push:list

OPTIONS
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

See code: src/commands/source/push/list.ts

coveo source:push:new NAME

Create a new push source in a Coveo organization

USAGE
  $ coveo source:push:new NAME

ARGUMENTS
  NAME  The name of the source to create.

OPTIONS
  -v, --sourceVisibility=(PRIVATE|SECURED|SHARED)  [default: SECURED] Controls the content security option that should
                                                   be applied to the items in a source. See
                                                   https://docs.coveo.com/en/1779/index-content/content-security

See code: src/commands/source/push/new.ts

coveo ui:create:angular NAME

Create a Coveo Headless-powered search page with the Angular web framework. See https://docs.coveo.com/headless and https://angular.io/.

USAGE
  $ coveo ui:create:angular NAME

ARGUMENTS
  NAME  The name of the application to create.

OPTIONS
  -d, --defaults         Whether to automatically select the default value for all prompts that have a default value.
  -v, --version=version  [default: 1.17.0] The version of @coveo/angular to use.

See code: src/commands/ui/create/angular.ts

coveo ui:create:react NAME

Create a Coveo Headless-powered search page with the React web framework. See https://docs.coveo.com/headless and https://reactjs.org/.

USAGE
  $ coveo ui:create:react NAME

ARGUMENTS
  NAME  The name of the application to create.

OPTIONS
  -v, --version=version  [default: 1.17.0] Version of @coveo/cra-template to use.

EXAMPLES
  $ coveo ui:create:react myapp
  $ coveo ui:create:react --help

See code: src/commands/ui/create/react.ts

coveo ui:create:vue NAME

Create a Coveo Headless-powered search page with the Vue.js web framework. See https://docs.coveo.com/headless and https://vuejs.org/.

USAGE
  $ coveo ui:create:vue NAME

ARGUMENTS
  NAME  The name of the application to create.

OPTIONS
  -h, --help             show CLI help

  -p, --preset=path      The path to a JSON file with pre-defined options and plugins for creating a new project.
                         If not specified, the default TypeScript preset is used.
                         For more information about Vue CLI presets, see
                         https://cli.vuejs.org/guide/plugins-and-presets.html#presets.

  -v, --version=version  [default: 1.17.0] The version of @coveo/vue-cli-plugin-typescript to use.

EXAMPLES
  $ coveo ui:create:vue --preset path/to/my/preset.json
  $ coveo ui:create:vue --help

See code: src/commands/ui/create/vue.ts

coveo update [CHANNEL]

update the coveo CLI

USAGE
  $ coveo update [CHANNEL]

OPTIONS
  --from-local  interactively choose an already installed version

See code: @oclif/plugin-update