Socket
Socket
Sign inDemoInstall

@sitecore-search/cli

Package Overview
Dependencies
9
Maintainers
0
Versions
75
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@sitecore-search/cli

Sitecore Search SDK cli


Version published
Weekly downloads
865
decreased by-10.82%
Maintainers
0
Created
Weekly downloads
 

Readme

Source
Logo


@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

OptionDescription
--versionShows version number
-h, --hShows help

Available actions

CommandDescriptionAliasesOptions
new-widgetGenerates files to create a new widgetnw--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.

FAQs

Last updated on 02 Jul 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc