Salla CLI

Bringing You the Power of Salla to Your Terminal.
Explore our blogs »

Report Bug · Request Feature . </Salla Developers>

Table of Contents

1. Overview
2. Getting Started
   • Prerequisites
   • Usage
3. Support
4. Security
5. Credits
6. License

Overview

The Salla Command Line Interface (Salla CLI) is your way to create your starter Salla Apps which works with the Salla APIs. Your App later can be published to the Salla App Store and be available for installation to any of Salla Merchants Stores.

(back to top)

Getting Started

The Salla CLI is available via npm and is packaged to be used globally so you can access it everywhere. With the official documentation, take the terminal experience to the next level

Salla CLI comes with an easy to use, straightforward commands that do the complete setup to your Salla App. To be ready, you will need some prerequisites which will be listed hereafter.

What can you use Salla CLI for?

• Easily create your Salla Apps and Themes on the Salla Partners Portal.
• Utilize the Starter Kits (ExpressJS and Laravel) to develop your apps.
• Deploy your apps for public testing and showcase your themes on demo stores for previewing.
• Publish your apps on the Salla App Store and your themes on the Salla Theme Marketplace.

Prerequisites

• Create a Partner account at Salla Partners Portal.
• For Salla CLI's compatibility: Nodejs LTS>= 16.13.1 and npm>= 6.14.0.
• Other requirments:PHP >= 7.4, Composer package manager.

Usage

To install Salla CLI, run the following command:

npm install @salla.sa/cli -g

And you're now ready to start building your apps with Salla Partners Portal !

After installation, you will have access to the salla binary in your command line. You can verify that the CLI is properly installed by simply running the binary command, salla, which should present you with a help message listing all available commands.

You can check you have the right version with this command:

salla --version

The convention followed to execute Salla CLI Commands is:

salla <command>

Available Commands:
  Command:                         Description:                                      Properties:
  salla login                      Login to your Salla Partners account              -
  salla version                    Show the version of Salla CLI                     -
  salla app                        Show list of commands with the binary `app`       -
  salla app create                 Create a new Salla 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 your Salla Apps                          -
  salla app info                   Show detailed app information                     -
  salla app link                   Link your local app with Salla Partners           -
  salla app serve                  Serve an existing Salla App                       [-p,-l]
  salla theme create               Create a new Salla Store Theme                    -
  salla theme preview              Build, deploy, and preview the theme locally      -
  salla theme list                 List all your Salla Store Themes                  -
  salla theme delete               Delete an existing Salla Store Theme              -
  salla theme publish              Submit Theme for publishing approval              -

Explore about Theme Commands through the official documentation

Upgrade

To upgrade Salla CLI package globally, you need to run:

npm update @salla.sa/cli -g

Support

The team is always here to help you. Happen to face an issue? Want to report a bug? You can submit one here on Github using the Issue Tracker. If you still have any questions, please contact us by joining the Global Developer Community on Telegram or via the Support Email.

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

Credits

• Salla
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

(back to top)