This is no longer supported, please consider using the official Coveo CLI instead.
- DEPRECATED
⛔️ DEPRECATED This repository contains a command line tool to perform administrative tasks in the Coveo Cloud V2 Platform. It also allows the automation of tasks that previously had to be done manually, like graduating the configuration from organizations in a different stage (e.g.: DEV, UAT, PROD).
Unlike the platformclient
CLI, the Coveo
CLI supports Oauth. This means, you no longer need to enter API keys on every commands. Instead, you only need to authenticate once to the Coveo platform and the CLI will keep you authenticated as long as your API key has not expired. Otherwise, you will be asked to authenticate again.
coveo auth:login --organization=<organizationId>
The platformclient download-<resourceType>
commands have been replaced with coveo org:resources:pull --resourceTypes <resourceTypes>
.
Unlike the platformclient
CLI, the Coveo
CLI can pull all the organization resources if the --resourceTypes
flag is not specified.
Once you have pulled your organization resources with the coveo org:resources:pull
command, you can push them to any organization.
How to pull/download all the fields available in your organization.
platformclient download-fields [options] <origin>
coveo org:resources:pull --resourceTypes field
The platformclient diff-<resourceType>
commands have been replaced with coveo org:resources:preview
.
Once you have pulled your resources with the coveo org:resources:pull
command, you can preview the changes against any organization.
platformclient diff-fields [options] <origin> <destination>
coveo org:resources:preview --target <destination>
The platformclient graduate-<resourceType>
commands have been replaced with coveo org:resources:push
.
Once you have pulled your resources with the coveo org:resources:pull
command, you can push the changes to any organization.
platformclient diff-fields [options] <origin> <destination>
coveo org:resources:push --target <destination>
The platformclient upload-<resourceType>
commands can also be replaced with coveo org:resources:push
.