Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Sparrow CLI

The Sparrow command-line interface tool that helps you quickly build, validate & test Sparrow apps. You can also use it to automate many common development tasks. To view the list of CLI commands, after you install the CLI, at the command prompt type ssdk and press Enter.

Commands:

The Sparrow command-line interface tool that helps you quickly build, validate & test Sparrow apps. You can also use it to automate many common development tasks

Here are the list of commands which can be used in the command line interface

1. Create

2. Run

3. Validate

4. Pack

5. version

Create:

  • The command creates an app in the specified directory, based on the default app template. If no directory is specified, the app is created in the current directory.

  • ssdk create [--app-dir DIR] [--product PRODUCT] [--template TEMPLATE]

OPTIONS USAGE
–app-dir To specify the absolute or relative path of the project directory where the app is to be created. If the option is not used with the create command, the app is created in the current directory.
–products To specify the product for which the app is created. If the option is not used with the create command, you are prompted to select a product. Select surveysparrow.
–template To specify the template for which the app is created. If the option is not used with the create command, you are prompted to select a template. Select the your_first_app template to create a front-end app. The templates should be one of your_first_app, your_first_serverless_app, your_first_react_app

Run:

OPTIONS SHORT-HAND NOTATION USAGE DESCRIPTION
–app-dir -d General syntax: ssdk run -d <DIR>
<DIR> is the directory path to the folder containing the app that is tested locally through the ssdk run command. Example ssdk run -d /user/myFirstApp
Specifies the directory path to the folder that contains the app that is tested locally.

Validate:

This command validates whether the app code is error-free. If there are errors in the code, corresponding violations are displayed after the command is run.

ssdk validate [--app-dir DIR]

Pack:

This command generates the dist/your_app.zip in the current app directory, later this zip can be used to publish the app.

ssdk pack [--app-dir DIR]

Version:

To find the current version of the ssdk installed locally

ssdk version