# coveo-platform-client > A client to manage organizations in the Coveo Cloud Platform Latest version **3.6.1** (published 2021-09-22) · Apache-2.0 license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install coveo-platform-client pnpm add coveo-platform-client yarn add coveo-platform-client bun add coveo-platform-client ``` Provides the command `platformclient`. ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 3.6.1 | | Published | 2021-09-22 | | First published | 2018-03-19 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 19 | | Unpacked size | 216.3 KB | | Known vulnerabilities | 0 (+3 in 2 direct dependencies) | | Install scripts | no | | GitHub stars | 6 | | Author | Yassine Lakhdar | | Maintainers | ylakhdar | | Keywords | coveo, cloud, platform, graduation, diff, fields, extensions | ## Links - npm: https://www.npmjs.com/package/coveo-platform-client - Repository: https://github.com/coveooss/platform-client - Homepage: https://github.com/coveooss/platform-client#readme - Issues: https://github.com/coveooss/platform-client/issues - npm.io page: https://npm.io/package/coveo-platform-client ## Dependencies (19) - [ejs](https://npm.io/package/ejs.md) ^3.1.5 - [ora](https://npm.io/package/ora.md) ^5.0.0 - [diff](https://npm.io/package/diff.md) ^4.0.2 - [flat](https://npm.io/package/flat.md) 5.0.2 - [open](https://npm.io/package/open.md) ^7.1.0 - [snyk](https://npm.io/package/snyk.md) ^1.373.1 - [async](https://npm.io/package/async.md) ^3.2.0 - [boxen](https://npm.io/package/boxen.md) ^5.0.1 - [chalk](https://npm.io/package/chalk.md) 4.1.0 - [request](https://npm.io/package/request.md) ^2.88.2 - [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1 - [inquirer](https://npm.io/package/inquirer.md) ^7.3.3 - [commander](https://npm.io/package/commander.md) ^6.0.0 - [puppeteer](https://npm.io/package/puppeteer.md) ^5.3.1 - [strip-ansi](https://npm.io/package/strip-ansi.md) ^6.0.0 - [typescript](https://npm.io/package/typescript.md) ^3.9.7 - [underscore](https://npm.io/package/underscore.md) 1.10.2 - [deep-extend](https://npm.io/package/deep-extend.md) ^0.6.0 - [update-notifier](https://npm.io/package/update-notifier.md) ^4.1.0 ## Alternatives - [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads - [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads - [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads - [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads - [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads ## Recent versions - 3.6.1 (latest) — 2021-09-22 - 1.3.0 (v.1.3.0) — 2018-11-28 - 1.2.1 (v.1.2.1) — 2018-11-28 - 3.6.0 — 2021-09-22 - 3.5.0 — 2021-01-12 - 3.4.0 — 2020-10-19 - 3.3.0 — 2020-10-19 - 3.2.0 — 2020-10-19 - 3.1.0 — 2020-10-13 - 3.0.1 — 2020-10-06 - 3.0.0 — 2020-10-01 - 2.13.0 — 2020-10-01 - 2.12.1 — 2020-06-16 - 2.12.0 — 2020-05-12 - 2.11.1 — 2020-02-26 - … 38 more at https://npm.io/package/coveo-platform-client/versions ## README # DEPRECATED [![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/) **This is no longer supported, please consider using the official [Coveo CLI](https://www.npmjs.com/package/@coveo/cli) instead.** - [DEPRECATED](#deprecated) - [Description](#description) - [Moving from `platformclient` CLI to `coveo` CLI.](#moving-from-platformclient-cli-to-coveo-cli) - [Authentication](#authentication) - [How to authenticate with the Coveo CLI](#how-to-authenticate-with-the-coveo-cli) - [Download commands](#download-commands) - [Example](#example) - [with the `platformclient` CLI](#with-the-platformclient-cli) - [with the `coveo` CLI](#with-the-coveo-cli) - [Diff commands](#diff-commands) - [Example for previewing only one resource type](#example-for-previewing-only-one-resource-type) - [with the `platformclient` CLI](#with-the-platformclient-cli-1) - [with the `coveo` CLI](#with-the-coveo-cli-1) - [Graduate commands](#graduate-commands) - [with the `platformclient` CLI](#with-the-platformclient-cli-2) - [with the `coveo` CLI](#with-the-coveo-cli-2) - [platformclient upload-](#platformclient-upload-resourcetype) ## Description ⛔️ **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). ## Moving from `platformclient` CLI to `coveo` CLI. ### Authentication 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. #### How to authenticate with the Coveo CLI ```bash coveo auth:login --organization= ``` ### Download commands The `platformclient download-` commands have been replaced with `coveo org:resources:pull --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. #### Example How to pull/download all the fields available in your organization. ##### with the `platformclient` CLI ```bash platformclient download-fields [options] ``` ##### with the `coveo` CLI ```bash coveo org:resources:pull --resourceTypes field ``` ### Diff commands The `platformclient diff-` 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. #### Example for previewing only one resource type ##### with the `platformclient` CLI ```bash platformclient diff-fields [options] ``` ##### with the `coveo` CLI ```bash coveo org:resources:preview --target ``` ### Graduate commands The `platformclient graduate-` 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. ##### with the `platformclient` CLI ```bash platformclient diff-fields [options] ``` ##### with the `coveo` CLI ```bash coveo org:resources:push --target ``` ### platformclient upload- The `platformclient upload-` commands can also be replaced with `coveo org:resources:push`. --- _Source: https://npm.io/package/coveo-platform-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._