# @coveo/cli-plugin-source

> Manage Coveo Sources with the Coveo CLI

Latest version **2.3.11** (published 2026-01-12) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @coveo/cli-plugin-source
pnpm add @coveo/cli-plugin-source
yarn add @coveo/cli-plugin-source
bun add @coveo/cli-plugin-source
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 2.3.11 |
| Published | 2026-01-12 |
| First published | 2022-08-26 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | ^18.18.1 \|\| ^20.9.0 |
| Dependencies | 9 |
| Unpacked size | 85.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 25 |
| Author | Coveo |
| Maintainers | coveo-organization, coveoit, npmcoveo, pixhel, oa-npmcoveo |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/@coveo/cli-plugin-source
- Repository: https://github.com/coveo/cli
- Issues: https://github.com/coveo/cli/issues
- npm.io page: https://npm.io/package/@coveo/cli-plugin-source

## Dependencies (9)

- [chalk](https://npm.io/package/chalk.md) 4.1.2
- [ts-dedent](https://npm.io/package/ts-dedent.md) 2.2.0
- [jsonschema](https://npm.io/package/jsonschema.md) 1.4.1
- [@oclif/core](https://npm.io/package/@oclif/core.md) 1.24.0
- [@coveo/cli-commons](https://npm.io/package/@coveo/cli-commons.md) 2.9.11
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) 5.1.23
- [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) 2.1.12
- [@coveo/platform-client](https://npm.io/package/@coveo/platform-client.md) 58.5.0
- [@coveo/push-api-client](https://npm.io/package/@coveo/push-api-client.md) 4.0.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 2.3.11 (latest) — 2026-01-12
- 2.3.11-0 (beta) — 2025-04-14
- 1.35.9-pre0 (alpha) — 2022-08-29
- 2.3.10 — 2025-03-25
- 2.3.9 — 2025-03-25
- 2.3.8 — 2025-03-24
- 2.3.8-0 — 2025-03-24
- 2.3.7 — 2025-03-24
- 2.3.7-0 — 2025-03-24
- 2.3.6 — 2025-03-24
- 2.3.6-0 — 2025-03-24
- 2.3.5 — 2025-03-24
- 2.3.5-1 — 2025-03-24
- 2.3.5-0 — 2025-03-21
- 2.3.4 — 2024-07-02
- … 154 more at https://npm.io/package/@coveo/cli-plugin-source/versions

## README

# Coveo CLI

<!-- removefromdocs -->

[![Build](https://github.com/coveo/cli/actions/workflows/build.yml/badge.svg)](https://github.com/coveo/cli/actions/workflows/build.yml)

<!-- endremovefromdocs -->

## What Is the Coveo CLI?

The Coveo CLI is a powerful command-line interface (CLI) that interacts with the Coveo platform to facilitate development and build automation.
Key features include the following:

- Quickly create a [Coveo Headless](https://docs.coveo.com/headless)-powered search page for your Coveo organization, relying on popular frameworks like [Angular](https://angular.io), [React](https://reactjs.org/), and [Vue.js](https://vuejs.org/).
- Quickly create a [Coveo Atomic](https://docs.coveo.com/atomic)-powered search page for your Coveo organization, with custom component examples and a search token provider.
- Create and manage Coveo [organizations](https://docs.coveo.com/en/3374).
- Automate deployments between organizations.
- Manage Coveo [Push API](https://docs.coveo.com/en/68) sources.
- Perform [queries](https://docs.coveo.com/en/l25h0358) against a Coveo index.

## When to Use the Coveo CLI?

We recommend the Coveo CLI both to newcomers who are looking for quick scaffolding options and to more seasoned Coveo developers who want to optimize their workflow. With the CLI, developers can get their frontend project started with a single command rather than by copy-pasting examples.
The CLI also lets you automate deployments on your machine or in your CI/CD pipeline using the `org:resources` commands and/or the `source` commands.

Most if not all of those operations can be done either through the Coveo Administration Console or directly using the Coveo REST APIs.
The former, while being easy to understand and get started with, can also be a bit cumbersome and time-consuming for repetitive tasks. The CLI lets you avoid this issue by providing single commands that can accomplish the target tasks, and by allowing you to automate and chain commands together easily.
The REST APIs are on the opposite side of the spectrum: they go straight to the point and avoid any repetition. They can however be quite hard to understand at first and require making numerous and complex requests to different APIs. The CLI can handle most of this complexity for you.

## Installation

You can install the CLI via [npm](https://www.npmjs.com/package/@coveo/cli):

```sh
npm install -g @coveo/cli
```

Afterward, you can run `npm update -g @coveo/cli` at any time to update your npm-based CLI installation to the latest version.

You can also run the CLI via [npx](https://www.npmjs.com/package/npx):

```sh
npx @coveo/cli
```

<!-- removefromdocs -->

## Validating your installation

To validate your CLI installation, use the `coveo --version` command:

<!-- usage -->

```sh-session
$ npm install -g @coveo/cli
$ coveo COMMAND
running command...
$ coveo (--version)
@coveo/cli/3.2.13 linux-x64 node-v20.12.2
$ coveo --help [COMMAND]
USAGE
  $ coveo COMMAND
...
```

<!-- usagestop -->

## Getting started

After you install the CLI, you'll typically want to [`login`](https://github.com/coveo/cli/tree/master/packages/cli/core#coveo-authlogin) to your Coveo Organization.
You can check out all the available commands [here](https://github.com/coveo/cli/tree/master/packages/cli/core).

<!--
  Add full examples for each use case:
  TODO: CDX-492 One example to explain how to use org:resources commands.
  Similar to the SFDX CLI intro (https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_intro.htm)
-->

The project is still under heavy development and more features are coming, stay tuned!

## Local Setup to Contribute

To install all dependencies and link local packages, run:

```sh
npm i
```

To run the local version of the CLI

```sh
./packages/cli/core/bin/dev
```

To build all projects for production, run:

```sh
npm run build
```

To run unit tests

```sh
npm run test
```

<!-- endremovefromdocs -->

---
_Source: https://npm.io/package/@coveo/cli-plugin-source · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
