@sitecore-search/cli

Command line tool for the Sitecore Discover React SDK.

Installation

npm install --save-dev @sitecore-search/cli

Running CLI

To run the cli execute the following command on a terminal:

npx sc-search

followed by any of the available options or actions.

E.g.: npx sc-search --version

Global options

| Option | Description | |-------------|----------------------| | --version | Shows version number | | -h, --h | Shows help |

Available actions

| Command | Description | Aliases | Options | |--------------------------|-------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | new-widget | Generates files to create a new widget | nw | --verbose (-v): Run with verbose logging --overwrite (-w): Overwrite the destination --suffix (-s): Template file suffix --template (-t): The template id --name (-n): The template component name --default-name (-d): Use the default template component name --output (-o): The path where you want your template --language (-l): The template language --styling (-st): The template styling |

E.g.: npx sc-search new-widget -v -n MyWidget -o widget/path -w

will create a new Widget named MyWidget in the widget/path and if the Widget already exist will overwrite it. If any of the parameters are omitted, the cli will prompt some questions to complete the missing information.

Settings

The cli will try to read a file named .sc-search-settings.json to get some settings. That file should be present in the same folder as the command has been called. Here is an example about that file should look like:

{
    "components-path": "src-test/components"
}

The destination of the generated widgets can be set there.