Logo

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
  3. Create Appliaction
  4. App Functions
  5. Auth
  6. Link
  7. Delete
  8. Upgrade
  9. Contributing
  10. Support
  11. Security
  12. Credits
  13. License
## Overview [The Salla Command Line Interface](https://github.com/SallaApp/Salla-CLI) (Salla CLI) is your way to create your starter Salla Apps which works with the [Salla APIs](https://docs.salla.dev/). Your App later can be published to the [Salla App Store](https://apps.salla.sa/) and be available for installation to any of Salla [Merchants Stores](https://salla.sa/).

(back to top)

## Getting Started The [Salla CLI](https://github.com/SallaApp/Salla-CLI) is available via npm and is packaged to be used globally so you can access it everywhere. [Salla CLI](https://github.com/SallaApp/Salla-CLI) comes with an easy to use, straight-forward commands that does 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](https://github.com/SallaApp/Salla-CLI) for? - Login to your [Salla Store](https://s.salla.sa/). - Single-taps to create your own Salla App on [Salla Partners Portal](https://salla.partners/). ### Prerequisites - Create a Partner account at [Salla Partners Portal](https://salla.partners/). - For Salla CLI's compatibility: [`Nodejs LTS`](https://nodejs.org/en/)`>= 16.13.1` and [`npm`](https://www.npmjs.com/)`>= 6.14.0`. - Other requirments:[`PHP`](https://www.php.net/) `>= 7.4`, [`Composer`](https://getcomposer.org/) `package manager`. ### Usage To install [Salla CLI](https://github.com/SallaApp/Salla-CLI), run the following command: ```bash npm install @salla.sa/cli -g ``` And you're now ready to start building your apps with [Salla Partners Portal](https://salla.partners/) ! 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: ```bash salla --version ``` The convention followed to execute Salla CLI Commands is: ```bash salla Available Commands: Command: Description: Properties: 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 app functions build Bundle your App Function into dist/index.js [app_id] salla app functions deploy Build and deploy your App Function bundle [app_id, --skip-build] salla app functions serve Stream your App Function's live logs [app_id, --raw] salla login Login to your Salla Store - salla version Show the version of Salla CLI - ``` ## Create Application Creating your [Salla App](https://salla.partners/) App is much easier with [Salla CLI](https://github.com/SallaApp/Salla-CLI). Run the following command to go through the wizard that would help you create your app: ```bash salla app create ``` List of existing apps assocaited to your account will be displayed as well as an option to create your app on [Salla Partners Portal](https://salla.partners/). Afterwards, you will be presented with easy-to fill in information to create your app. ![Salla App Create Command](https://i.ibb.co/92tKgZz/Clean-Shot-2021-12-27-at-21-31-15.gif) ### Serve Application To run and test an existing Salla App, run the following command: ```bash salla app serve ``` ![Salla App Serve Command](https://i.ibb.co/vHXPGMJ/Clean-Shot-2021-12-27-at-21-24-18.gif) ### Create Webhook Webhooks are a way to receive notifications from Salla when an event happens in your Salla App. For example, when a new order is placed, you can receive a notification via your own webhook. Read more on [the Official Docs](https://docs.salla.dev/docs/merchant/ZG9jOjI0NTE3NDg1-webhook). For utmost flexibility, you can stream a webhook for any event you want to receive. Run the following command to create a webhook: ```bash salla app create-webhook ``` ![Salla App Create-Webhook Command](https://i.ibb.co/yBstbgx/Clean-Shot-2021-12-27-at-16-16-47.gif) ## App Functions App Functions let your Partner app react to events that happen inside a merchant's store (an order is created, a customer logs in, …). You author small, typed handlers in an [App Functions project](https://github.com/SallaApp/app-functions-cli-template); Salla runs them for you when the events fire — no servers to manage. From inside your App Functions project, the CLI covers the whole loop — build, deploy, observe: ```bash salla app functions build # bundle src/index.ts into dist/index.js salla app functions deploy # build and ship your bundle to Salla salla app functions serve # stream your function's live logs ``` `` is your app's ID from the [Salla Partners Portal](https://salla.partners/). You can pass it as an argument (or via `--app-id`), or set it once in your project's `.env` file: ```bash SALLA_APP_ID=1234567890 ``` A successful `deploy` uploads the bundle, waits for the deployment to complete, and prints a **preview URL** to try your changes. `serve` then streams your function's logs (`console.log`, errors, …) to the terminal in real time. Useful options: - `salla app functions deploy --skip-build` — deploy the existing `dist/index.js` without rebuilding. - `salla app functions serve --raw` — print full websocket message envelopes instead of formatted log lines (for debugging). ## Authintication To communicate with your [Salla Partners Portal](https://salla.partners/) Apps, you will need to be authenticated. To do so, run the following command: ```bash salla login ``` That will handle all authentication and authorization process with your account on [Salla Partners Portal](https://salla.partners/). ![Salla App Login](https://i.ibb.co/Pmwzm0R/Clean-Shot-2021-12-28-at-17-11-57.gif) ## Link To link your local app with Salla Partners, you need to run: ```bash salla app link ``` List of existing apps assocaited to your account will be displayed where you will need to choose one application to link to your local app to. ![Salla App Link Command](https://i.ibb.co/bbFVX9r/Clean-Shot-2022-01-04-at-09-26-28.gif) ## Delete To delete your app directly from the CLI, you need to run: ```bash salla app delete ``` ![Salla App Delete Command](https://i.ibb.co/hWSfN95/Clean-Shot-2021-12-27-at-21-27-34.gif) ## Upgrade To upgrade [Salla CLI](https://github.com/SallaApp/Salla-CLI) package globally, you need to run: ```bash 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](https://github.com/SallaApp/Salla-CLI/issues/new). If you still have any questions, please contact us via the [Telegram Bot](https://t.me/SallaSupportBot) or join in the Global Developer Community on [Telegram](https://t.me/salladev). ## Security If you discover any security-related issues, please email `security@salla.sa` instead of using the issue tracker. ## Credits - [Salla](https://github.com/sallaApp) - [All Contributors](../../contributors) ## License The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

(back to top)