{"id":23638029,"url":"https://github.com/coveo/cli","last_synced_at":"2025-08-31T13:31:38.378Z","repository":{"id":37078257,"uuid":"331415053","full_name":"coveo/cli","owner":"coveo","description":"A command-line interface to interact with the Coveo platform and quickly create Coveo Headless-powered search pages with Angular, React or Vue.js.","archived":false,"fork":false,"pushed_at":"2024-05-23T00:57:53.000Z","size":83032,"stargazers_count":21,"open_issues_count":26,"forks_count":6,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-05-23T03:12:22.594Z","etag":null,"topics":["angular","cicd","cli","coveo","coveo-cli","iac","react","vuejs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coveo.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-20T19:50:55.000Z","updated_at":"2024-05-28T02:50:09.755Z","dependencies_parsed_at":"2023-09-23T11:19:32.109Z","dependency_job_id":"a1e7348b-bd66-40f9-bcd9-24bc773cc959","html_url":"https://github.com/coveo/cli","commit_stats":{"total_commits":1103,"total_committers":22,"mean_commits":50.13636363636363,"dds":0.5775158658204895,"last_synced_commit":"7951a5c920bf9d9e819a67d712653f342867f602"},"previous_names":[],"tags_count":307,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coveo%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coveo%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coveo%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coveo%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coveo","download_url":"https://codeload.github.com/coveo/cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231596177,"owners_count":18397852,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["angular","cicd","cli","coveo","coveo-cli","iac","react","vuejs"],"created_at":"2024-12-28T07:21:43.937Z","updated_at":"2025-08-31T13:31:38.365Z","avatar_url":"https://github.com/coveo.png","language":"TypeScript","readme":"# Coveo CLI\n\n\u003c!-- removefromdocs --\u003e\n\n[![Build](https://github.com/coveo/cli/actions/workflows/build.yml/badge.svg)](https://github.com/coveo/cli/actions/workflows/build.yml)\n\n\u003c!-- endremovefromdocs --\u003e\n\n## What Is the Coveo CLI?\n\nThe Coveo CLI is a powerful command-line interface (CLI) that interacts with the Coveo platform to facilitate development and build automation.\nKey features include the following:\n\n- 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/).\n- 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.\n- Create and manage Coveo [organizations](https://docs.coveo.com/en/3374).\n- Automate deployments between organizations.\n- Manage Coveo [Push API](https://docs.coveo.com/en/68) sources.\n- Perform [queries](https://docs.coveo.com/en/l25h0358) against a Coveo index.\n\n## When to Use the Coveo CLI?\n\nWe 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.\nThe 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.\n\nMost if not all of those operations can be done either through the Coveo Administration Console or directly using the Coveo REST APIs.\nThe 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.\nThe 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.\n\n## Installation\n\nYou can install the CLI via [npm](https://www.npmjs.com/package/@coveo/cli):\n\n```sh\nnpm install -g @coveo/cli\n```\n\nAfterward, you can run `npm update -g @coveo/cli` at any time to update your npm-based CLI installation to the latest version.\n\nYou can also run the CLI via [npx](https://www.npmjs.com/package/npx):\n\n```sh\nnpx @coveo/cli\n```\n\n\u003c!-- removefromdocs --\u003e\n\n## Validating your installation\n\nTo validate your CLI installation, use the `coveo --version` command:\n\n\u003c!-- usage --\u003e\n\n```sh-session\n$ npm install -g @coveo/cli\n$ coveo COMMAND\nrunning command...\n$ coveo (--version)\n@coveo/cli/3.2.13 linux-x64 node-v20.12.2\n$ coveo --help [COMMAND]\nUSAGE\n  $ coveo COMMAND\n...\n```\n\n\u003c!-- usagestop --\u003e\n\n## Getting started\n\nAfter 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.\nYou can check out all the available commands [here](https://github.com/coveo/cli/tree/master/packages/cli/core).\n\n\u003c!--\n  Add full examples for each use case:\n  TODO: CDX-492 One example to explain how to use org:resources commands.\n  Similar to the SFDX CLI intro (https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_intro.htm)\n--\u003e\n\nThe project is still under heavy development and more features are coming, stay tuned!\n\n## Local Setup to Contribute\n\nTo install all dependencies and link local packages, run:\n\n```sh\nnpm i\n```\n\nTo run the local version of the CLI\n\n```sh\n./packages/cli/core/bin/dev\n```\n\nTo build all projects for production, run:\n\n```sh\nnpm run build\n```\n\nTo run unit tests\n\n```sh\nnpm run test\n```\n\n\u003c!-- endremovefromdocs --\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoveo%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoveo%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoveo%2Fcli/lists"}