Usage
Salla CLI is the tool used to create Apps and themes. It comes with easy-to-use commands, for example, to create, list, and delete Apps and Themes. In order to use these commands, the developer needs to install Salla CLI. This article will explain how to install Salla CLI in order to use it in the developer environment and the primary usage of Salla CLI.
📙 What you'll learn
Install Salla CLI
To install Salla CLI, run the following command in the terminal. This command will install Salla CLI into the system globally.
npm install -g @salla.sa/cli
:::tip[Note]
For PowerShell users, sometimes the CLI might not be installed due to device restrictions. To enable that, execute the following command
// First fetch the execution policy
Get-ExecutionPolicy
// Override the execution policy
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
:::
The developer is now ready to start building Salla Apps and Themes with the Salla Partners Portal!
:::caution[Alert]
For machines with Apple silicon, it is a must to install Rosetta, which enables a Mac with Apple silicon to use apps built for a Mac with an Intel processor. Follow along for installation guide.
:::
Rosetta Installation
The first time you try to run an incompatible program, you will automatically be prompted to install Rosetta.
Simply, click Install
and you are good to go!
Use the following command line in your terminal
softwareupdate --install-rosetta
Salla CLI usage
After installation, the developer will have access to the salla
binary on their command line. The developer can verify that the CLI is properly installed by simply running the binary command, salla
, which should present the developer with a help message listing all available commands.
Checking the version can be done using this command:
salla --version
To get the list of commands for Salla CLI execute the following command:
salla
Or as an alternative the developer can use help
command:
help
The list of commands for Salla CLI
Command | Description | Properties |
---|---|---|
salla app |
Show list of commands with the binary app | - |
salla app create-webhook |
Create a new Salla App Webhook | event.name |
salla app delete |
Delete an existing Salla App | - |
salla app list |
List all Salla Apps | - |
salla app info |
Show detailed app information | - |
salla app link |
Link local app with Salla Partners | - |
salla app serve |
Serve an existing Salla App | [-p,-l] |
salla theme create |
Create the theme | - |
salla theme preview |
Preview the theme | - |
salla theme list |
List Themes | - |
salla theme delete |
Delete an existing Theme | - |
salla theme publish |
Publish the theme | - |
salla login |
Login to Salla Store | - |
salla version |
Show the version of Salla CLI | - |