{"version":"3.3.0","commands":{"update":{"id":"update","description":"Deprecated","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"flags":{},"args":[]},"atomic:component":{"id":"atomic:component","description":"Scaffold a new custom component. Meant to be executed in a component library created using the `coveo atomic:init --lib` command, or in an npm project, or in an empty folder.","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":["atomic:cmp"],"examples":["<%= config.bin %> <%= command.id %> --type=page myAwesomeComponent","<%= config.bin %> <%= command.id %> --type=result mySuperResultComponent"],"flags":{"type":{"name":"type","type":"option","description":"The kind of component to initialize.","multiple":false,"options":["page","result"]},"version":{"name":"version","type":"option","char":"v","description":"The version of @coveo/create-atomic-component or @coveo/create-atomic-result-component to use.","multiple":false,"default":"latest"}},"args":[{"name":"name","description":"The name of your component.","required":true}]},"atomic:init":{"id":"atomic:init","description":"Scaffold a project to work with the Coveo Atomic Framework.","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":["<%= config.bin %> <%= command.id %> --type=app myAwesomeSearchPage","<%= config.bin %> <%= command.id %> --type=lib myCustomAtomicComponentsLibrary"],"flags":{"type":{"name":"type","type":"option","description":"The kind of project to initialize. Use `app`/`application` to start a new Atomic search page project, and `lib`/`library` to start a custom component library.","multiple":false,"options":["app","application","lib","library"]},"version":{"name":"version","type":"option","char":"v","description":"The version of @coveo/create-atomic or @coveo/create-atomic-component-project  to use.","multiple":false,"default":"latest"}},"args":[{"name":"name","description":"The name of your project.","required":true}]},"auth:login":{"id":"auth:login","description":"Log in to the Coveo Platform using the OAuth2 flow.\nNote: TCP port 32111 or 52296 must be available.","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":["$ coveo auth:login"],"flags":{"region":{"name":"region","type":"option","char":"r","description":"The Coveo Platform region to log in to. See <https://docs.coveo.com/en/2976>.","multiple":false,"options":["US","us","EU","eu","AU","au","CA","ca"],"default":"us"},"environment":{"name":"environment","type":"option","char":"e","description":"The Coveo Platform environment to log in to.","multiple":false,"options":["dev","stg","hipaa","prod"],"default":"prod"},"organization":{"name":"organization","type":"option","char":"o","description":"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`.","helpValue":"myOrgID","multiple":false}},"args":[]},"auth:token":{"id":"auth:token","description":"Log in to the Coveo Platform using an access token.","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":["$ coveo auth:token"],"flags":{"region":{"name":"region","type":"option","char":"r","description":"The Coveo Platform region to log in to. See <https://docs.coveo.com/en/2976>.","multiple":false,"options":["US","us","EU","eu","AU","au","CA","ca"],"default":"us"},"environment":{"name":"environment","type":"option","char":"e","description":"The Coveo Platform environment to log in to.","multiple":false,"options":["dev","stg","hipaa","prod"],"default":"prod"},"stdin":{"name":"stdin","type":"boolean","char":"s","description":"Whether to read the token from stdin. Default to true when running in a CI environment.","allowNo":true}},"args":[]},"config:get":{"id":"config:get","description":"Display the current Coveo CLI configuration.","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":[{"command":"coveo config:get","description":"Get all the configuration values"},{"command":"coveo config:get organization","description":"Get the organization to which you are connected"},{"command":"coveo config:get accessToken","description":"Get the access token given to you by the Coveo Platform"}],"flags":{},"args":[{"name":"key","description":"The config key for which to show the value","required":false}]},"config:set":{"id":"config:set","description":"Modify the current Coveo CLI configuration.","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":[{"command":"coveo config:set --organization myOrgId","description":"connect to a different organization"}],"flags":{"organization":{"name":"organization","type":"option","char":"o","description":"The identifier of the organization inside which to perform operations. See <https://docs.coveo.com/en/1562/#organization-id-and-other-information>.","helpValue":"myOrgID","multiple":false}},"args":[]},"org:create":{"id":"org:create","description":"Create a new test Coveo organization.","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"flags":{"setDefaultOrganization":{"name":"setDefaultOrganization","type":"boolean","char":"s","description":"Set the created organization as the default one","allowNo":true}},"args":[{"name":"name","description":"The name to assign to the new organization.","required":true}]},"org:list":{"id":"org:list","description":"List Coveo organizations.","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"flags":{"columns":{"name":"columns","type":"option","description":"only show provided columns (comma-separated)","multiple":false,"exclusive":["extended"]},"sort":{"name":"sort","type":"option","description":"property to sort by (prepend '-' for descending)","multiple":false},"filter":{"name":"filter","type":"option","description":"filter property by partial string matching, ex: name=foo","multiple":false},"csv":{"name":"csv","type":"boolean","description":"output is csv format [alias: --output=csv]","allowNo":false,"exclusive":["no-truncate"]},"output":{"name":"output","type":"option","description":"output in a more machine friendly format","multiple":false,"options":["csv","json","yaml"],"exclusive":["no-truncate","csv"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"show extra columns","allowNo":false,"exclusive":["columns"]},"no-truncate":{"name":"no-truncate","type":"boolean","description":"do not truncate output to fit screen","allowNo":false,"exclusive":["csv"]},"no-header":{"name":"no-header","type":"boolean","description":"hide table header from output","allowNo":false,"exclusive":["csv"]}},"args":[]},"ui:deploy":{"id":"ui:deploy","summary":"Deploy your search application to the Coveo infrastructure.","description":"The target \"config\" must contain the following parameters:\n  {\n    \"name\": \"The name of the hosted search page.\",\n    \"dir\": \"The directory of the hosted search page.\",\n    \"htmlEntryFile\": {\n      \"path\": \"The path to an HTML file containing the HTML markup of the hosted page.\"\n    },\n    \"javascriptEntryFiles\": [\n      {\n        \"path\": \"The path to a bundled Javascript file.\",\n        \"isModule\": \"Whether the inline code should be treated as a JavaScript module. If this property is true, the type property will be set to \"module\" on the script tag.\"\n      }\n    ],\n    \"javascriptUrls\": [\n      {\n        \"path\": \"The URL of the JavaScript source file.\",\n        \"isModule\": \"Whether the inline code should be treated as a JavaScript module. If this property is true, the type property will be set to \"module\" on the script tag.\"\n      }\n    ],\n    \"cssEntryFiles\": [\n      {\n        \"path\": \"The path to a bundled CSS file.\"\n      }\n    ],\n    \"cssUrls\": [\n      {\n        \"path\": \"The URL of the CSS stylesheet.\"\n      }\n    ]\n  }","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":["atomic:deploy"],"examples":[{"command":"<%= config.bin %> <%= command.id %>","description":"Create a new Hosted Page according to the configuration in the file \"coveo.deploy.json\""},{"command":"<%= config.bin %> <%= command.id %> -p 7944ff4a-9943-4999-a3f6-3e81a7f6fb0a","description":"Update the Hosted Page whose ID is \"7944ff4a-9943-4999-a3f6-3e81a7f6fb0a\" according to the configuration in the file \"coveo.deploy.json\""},{"command":"<%= config.bin %> <%= command.id %> -c ./configs/myconfig.json","description":"Create a new Hosted Page according to the configuration in the file located at \"./configs/myconfig.json\""}],"flags":{"pageId":{"name":"pageId","type":"option","char":"p","description":"The existing ID of the target Hosted search page.","required":false,"helpValue":"7944ff4a-9943-4999-a3f6-3e81a7f6fb0a","multiple":false},"config":{"name":"config","type":"option","char":"c","description":"The path to the deployment JSON configuration.","required":false,"helpValue":"coveo.deploy.json","multiple":false,"default":"coveo.deploy.json"},"organization":{"name":"organization","type":"option","char":"o","description":"The unique identifier of the organization where to deploy the hosted page. If not specified, the organization you are connected to will be used.","required":false,"helpValue":"targetorganizationg7dg3gd","multiple":false}},"args":[]},"org:resources:list":{"id":"org:resources:list","description":"List available Snapshots in an organization","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":["coveo org:resources:list -o=myOrgId"],"flags":{"columns":{"name":"columns","type":"option","description":"only show provided columns (comma-separated)","multiple":false,"exclusive":["extended"]},"sort":{"name":"sort","type":"option","description":"property to sort by (prepend '-' for descending)","multiple":false},"filter":{"name":"filter","type":"option","description":"filter property by partial string matching, ex: name=foo","multiple":false},"csv":{"name":"csv","type":"boolean","description":"output is csv format [alias: --output=csv]","allowNo":false,"exclusive":["no-truncate"]},"output":{"name":"output","type":"option","description":"output in a more machine friendly format","multiple":false,"options":["csv","json","yaml"],"exclusive":["no-truncate","csv"]},"extended":{"name":"extended","type":"boolean","char":"x","description":"show extra columns","allowNo":false,"exclusive":["columns"]},"no-truncate":{"name":"no-truncate","type":"boolean","description":"do not truncate output to fit screen","allowNo":false,"exclusive":["csv"]},"no-header":{"name":"no-header","type":"boolean","description":"hide table header from output","allowNo":false,"exclusive":["csv"]},"organization":{"name":"organization","type":"option","char":"o","description":"The unique identifier of the organization containing the snapshots. If not specified, the organization you are connected to will be used.","required":false,"helpValue":"targetorganizationg7dg3gd","multiple":false}},"args":[]},"org:resources:monitor":{"id":"org:resources:monitor","description":"Monitor a Snapshot operation","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":[{"command":"coveo org:resources:monitor --organization myorgid --snapshotId mysnapshotid","description":"Monitor the status of the \"mysnapshotid\" snapshot in the \"myorgid\" organization."}],"flags":{"wait":{"name":"wait","type":"option","char":"w","description":"The maximum number of seconds to wait before the commands exits with a timeout error. A value of zero means that the command will wait indefinitely.","required":false,"helpValue":"seconds","multiple":false,"default":60},"organization":{"name":"organization","type":"option","char":"o","description":"The unique identifier of the organization containing the snapshot. If not specified, the organization you are connected to will be used.","required":false,"helpValue":"targetorganizationg7dg3gd","multiple":false}},"args":[{"name":"snapshotId","description":"The unique identifier of the target snapshot.","required":true}]},"org:resources:preview":{"id":"org:resources:preview","description":"Preview the changes that running `coveo org:resources:push` would cause","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":["coveo org:resources:preview","coveo org:resources:preview -o=myOrgId","coveo org:resources:preview -o=myOrgId -d"],"flags":{"wait":{"name":"wait","type":"option","char":"w","description":"The maximum number of seconds to wait before the commands exits with a timeout error. A value of zero means that the command will wait indefinitely.","required":false,"helpValue":"seconds","multiple":false,"default":60},"previewLevel":{"name":"previewLevel","type":"option","char":"p","description":"The verbosity of the preview. The `light` preview is faster to generate but only contains a limited amount of information, as opposed to the `detailed` preview that takes more time to generate, but returns a diff representation of all the changes to apply.","helpValue":"(none|light|detailed)","multiple":false,"options":["none","light","detailed"],"default":"detailed"},"organization":{"name":"organization","type":"option","char":"o","description":"The unique identifier of the organization where to preview the changes If not specified, the organization you are connected to will be used.","required":false,"helpValue":"targetorganizationg7dg3gd","multiple":false},"snapshotId":{"name":"snapshotId","type":"option","char":"s","description":"The unique identifier of the snapshot to pull. If not specified, a new snapshot will be created. You can list available snapshot in your organization with org:resources:list","multiple":false,"exclusive":["resourceTypes"]},"showMissingResources":{"name":"showMissingResources","type":"boolean","char":"d","description":"Preview resources deletion when enabled","required":false,"allowNo":false}},"args":[]},"org:resources:pull":{"id":"org:resources:pull","description":"Pull resources from an organization","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":[{"command":"coveo org:resources:pull","description":"Pull all resources from the organization in which you are authenticated"},{"command":"coveo org:resources:pull --organization myorgid --wait 0","description":"Pull all resources from the organization whose ID is \"myorgid\" and do not timeout"},{"command":"coveo org:resources:pull --model my/snapshot/pull/model.json","description":"Pull only the resources specified in the snapshot pull model"},{"command":"coveo org:resources:pull --resourceTypes QUERY_PIPELINE FIELD,","description":"Pull all query pipelines and fields available in the organization"}],"flags":{"wait":{"name":"wait","type":"option","char":"w","description":"The maximum number of seconds to wait before the commands exits with a timeout error. A value of zero means that the command will wait indefinitely.","required":false,"helpValue":"seconds","multiple":false,"default":60},"organization":{"name":"organization","type":"option","char":"o","description":"The unique identifier of the organization from which to pull the resources If not specified, the organization you are connected to will be used.","required":false,"helpValue":"targetorganizationg7dg3gd","multiple":false},"snapshotId":{"name":"snapshotId","type":"option","char":"s","description":"The unique identifier of the snapshot to pull. If not specified, a new snapshot will be created. You can list available snapshot in your organization with org:resources:list","multiple":false,"exclusive":["resourceTypes"]},"git":{"name":"git","type":"boolean","char":"g","description":"Whether to create a git repository when creating a new project.","allowNo":true},"overwrite":{"name":"overwrite","type":"boolean","char":"f","description":"Overwrite resources directory if it exists.","allowNo":false},"resourceTypes":{"name":"resourceTypes","type":"option","char":"r","description":"The resources types to pull from the organization.","required":false,"helpValue":"type1 type2","multiple":true,"options":["EXTENSION","FEATURED_RESULT","FIELD","FILTER","INSIGHT_PANEL_CONFIGURATION","INSIGHT_PANEL_INTERFACE","CATALOG","CATALOG_CONFIG","MAPPING","QUERY_PARAMETER","QUERY_PIPELINE","QUERY_PIPELINE_CONDITION","RANKING_EXPRESSION","RANKING_WEIGHT","SEARCH_PAGE","SECURITY_PROVIDER","SOURCE","STOP_WORD","SUBSCRIPTION","THESAURUS","TRIGGER","RESULT_RANKING","STATEMENT_GROUP"]},"model":{"name":"model","type":"option","char":"m","description":"The path to a snapshot pull model. This flag is useful when you want to include only specific resource items in your snapshot (e.g., a subset of sources). Use the \"org:resources:model:create\" command to create a new Snapshot Pull Model","helpValue":"path/to/snapshot.json","multiple":false,"exclusive":["snapshotId","resourceTypes","target"]}},"args":[]},"org:resources:push":{"id":"org:resources:push","description":"Preview, validate and deploy your changes to the destination org","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":[{"command":"coveo org:resources:push","description":"Preview, validate and deploy resources to the organization in which you are authenticated"},{"command":"coveo org:resources:push --organization myorgid","description":"Preview, validate and deploy resources to the organization whose ID is \"myorgid\""},{"command":"coveo org:resources:push --previewLevel none","description":"Validate and deploy resources without displaying a preview"},{"command":"coveo org:resources:push --deleteMissingResources","description":"Preview, validate and deploy resources, but also delete from the organization all the resources that are not available inside the \"resources/\" directory"}],"flags":{"wait":{"name":"wait","type":"option","char":"w","description":"The maximum number of seconds to wait before the commands exits with a timeout error. A value of zero means that the command will wait indefinitely.","required":false,"helpValue":"seconds","multiple":false,"default":60},"previewLevel":{"name":"previewLevel","type":"option","char":"p","description":"The verbosity of the preview. The `light` preview is faster to generate but only contains a limited amount of information, as opposed to the `detailed` preview that takes more time to generate, but returns a diff representation of all the changes to apply.","helpValue":"(none|light|detailed)","multiple":false,"options":["none","light","detailed"],"default":"detailed"},"organization":{"name":"organization","type":"option","char":"o","description":"The unique identifier of the organization where to send the changes If not specified, the organization you are connected to will be used.","required":false,"helpValue":"targetorganizationg7dg3gd","multiple":false},"deleteMissingResources":{"name":"deleteMissingResources","type":"boolean","description":"Delete missing resources when enabled","required":false,"allowNo":false}},"args":[]},"org:search:dump":{"id":"org:search:dump","description":"  Dump the content of one or more sources in CSV format.\n\n  Note: DictionnaryFields/Values are experimentally supported. In case of failure, you should exclude them using the `-x` flag.","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":[{"command":"coveo org:search:dump --source \"My Web Source\" \"My Sitemap Source\"","description":"Get content indexed into the \"My Web Source\" and \"My Sitemap Source\" sources."},{"command":"coveo org:search:dump --source Products --pipeline Search --additionalFilter \"@cat_categories==(Shorts, Jackets)\"","description":"Get all the products coming from the \"Search\" pipeline that are either in the \"Shorts\" or \"Jackets\" category."},{"command":"coveo org:search:dump --source Products --pipeline Search --additionalFilter \"@cat_categories==Shorts AND @color==Black\"","description":"Get all the products coming from the \"Search\" pipeline that are in the \"Shorts\" category and have the color \"Black\"."},{"command":"coveo org:search:dump --fieldsToExclude ec_description ec_summary","description":"Get all the documents without the fields \"ec_description\" and \"ec_summary\" in them."}],"flags":{"source":{"name":"source","type":"option","char":"s","description":"The names (not the identifiers) of the sources from which to get content.","required":true,"helpValue":"mySourceName","multiple":true},"pipeline":{"name":"pipeline","type":"option","char":"p","description":"The name of the query pipeline through which to get content. If not specified, the default query pipeline is used. See <https://docs.coveo.com/en/180>","multiple":false},"fieldsToExclude":{"name":"fieldsToExclude","type":"option","char":"x","description":"The fields to exclude from the data dump. If not specified, all fields are included.","multiple":true},"destination":{"name":"destination","type":"option","char":"d","description":"The folder in which to create the CSV files. The data dump will fail if the folder doesn't exist.","multiple":false,"default":"."},"name":{"name":"name","type":"option","char":"n","description":"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.","multiple":false,"default":"indexdump"},"additionalFilter":{"name":"additionalFilter","type":"option","char":"f","description":"The additional search filter to apply while getting the content. See <https://docs.coveo.com/en/1552>.","multiple":false,"default":""},"chunkSize":{"name":"chunkSize","type":"option","char":"c","description":"The maximum number of results to dump into each CSV file.","multiple":false,"default":10000}},"args":[],"DefaultNumberOfResultPerQuery":1000,"mandatoryFields":["rowid","sysrowid"],"ResponseExceededMaximumSizeType":"ResponseExceededMaximumSizeException"},"ui:create:angular":{"id":"ui:create:angular","description":"Create a Coveo Headless-powered search page with the Angular web framework. See <https://docs.coveo.com/headless> and <https://angular.io/>.","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"flags":{"version":{"name":"version","type":"option","char":"v","description":"The version of @coveo/angular to use.","multiple":false,"default":"1.36.16"},"defaults":{"name":"defaults","type":"boolean","char":"d","description":"Whether to automatically select the default value for all prompts that have a default value.","allowNo":false}},"args":[{"name":"name","description":"The name of the application to create.","required":true}],"templateName":"@coveo/angular","requiredNodeVersion":"^18.18.1 || ^20.9.0","requiredNpmVersion":"^9.8.1 || ^10.1.0","requiredNgVersion":"^15.0.0"},"ui:create:atomic":{"id":"ui:create:atomic","description":"Create a Coveo Headless-powered search page with Coveo's own Atomic framework. See <https://docs.coveo.com/atomic> and <https://docs.coveo.com/headless>.","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":["$ coveo ui:create:atomic myapp"],"flags":{"version":{"name":"version","type":"option","char":"v","description":"The version of @coveo/create-atomic to use.","multiple":false,"default":"latest"},"pageId":{"name":"pageId","type":"option","char":"p","description":"The hosted search page ID.","required":false,"helpValue":"7944ff4a-9943-4999-a3f6-3e81a7f6fb0a","multiple":false}},"args":[{"name":"name","description":"The name of the application to create.","required":true}]},"ui:create:react":{"id":"ui:create:react","description":"Create a Coveo Headless-powered search page with the React web framework. See <https://docs.coveo.com/headless> and <https://reactjs.org/>.","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":["$ coveo ui:create:react myapp","$ coveo ui:create:react --help"],"flags":{"version":{"name":"version","type":"option","char":"v","description":"Version of @coveo/cra-template to use.","multiple":false,"default":"1.38.25"}},"args":[{"name":"name","description":"The name of the application to create.","required":true}],"templateName":"@coveo/cra-template","cliPackage":"create-react-app@latest","requiredNodeVersion":"^18.18.1 || ^20.9.0"},"ui:create:vue":{"id":"ui:create:vue","description":"Create a Coveo Headless-powered search page with the Vue3 and Vite. See <https://docs.coveo.com/headless> and <https://vuejs.org/>.","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"examples":["$ coveo ui:create:vue myVueProject","$ coveo ui:create:vue-v=1.2.3 myVueProject"],"flags":{"version":{"name":"version","type":"option","char":"v","description":"The version of @coveo/create-headless-vue to use.","multiple":false,"default":"1.4.7"}},"args":[{"name":"name","description":"The name of the application to create.","required":true}],"packageName":"@coveo/create-headless-vue","npmInitName":"@coveo/headless-vue","requiredNodeVersion":"^18.18.1 || ^20.9.0"},"org:resources:model:create":{"id":"org:resources:model:create","description":"Create a Snapshot Pull Model","strict":true,"pluginName":"@coveo/cli","pluginAlias":"@coveo/cli","pluginType":"core","aliases":[],"flags":{},"args":[]}}}