Yalo Partners

The Yalo Developer Hub

Welcome to the Yalo developer hub. You'll find comprehensive guides and documentation to help you start working with Yalo as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference

Installing the Yalo CLI

The Yalo CLI is the preferred way of setting up and deploying applications that run on Yalo. Consider it your first step into a wider world.


You need access to the following:

  • Yalo bitbucket
  • Access to Yalo 1Password "Keys" vault

you will also need the following third-party tools:

The following tools are recommended:

The following instructions are mac-centric, although they work with very little modification on other operating systems.


Mac Users

If you are running on a mac, have the OS X developer tools installed. We also recommend Homebrew and "brew cask" to install packaged tools like Terraform.


Windows Users

TL;DR: it's not here yet. The Yalo CLI relies on standard tools in POSIX (unix-like) operating systems. WSL is not officially supported yet.

SDK Components

For now, the CLI install requires setup the prior installation of SDK components using git. Clone them to the ~/yalo directory:

git clone https://bitbucket.org/yalochat/sdk.git ~/.yalo

or, if you prefer to use SSH with Bitbucket:

git clone [email protected]:yalochat/sdk.git ~/.yalo

The SDK contains build tools that will help you develop on the Yalo platform. If you want to experiment with the latest changes, check out the develop branch and set the upstream. (SSH version as above.)

git clone https://bitbucket.org/yalochat/sdk.git -b develop ~/.yalo

Some tools that we will use, such as access to Yalo's private NPM registry and Terraform build system, require

op signin yalochat.1password.com [email protected] A3-555555-RESTOFMYKEY

replacing [email protected] with your actual email address at Yalo, and A3-555555-RESTOFMYKEY with your Secret Key.

eval $(op signin yalochat)

Then execute the install script


It will download these secrets into the ~/.yalo/secrets directory. It will also create a ~/.yalo/env file which contains basic paths for developing all things Yalo. If you get an error, see the Troubleshooting page. You should see the following message:

********************************* DONE! ****************************************

Place these lines in your '~.bash_profile', '.profile' file or '.zshenv'

  export $(egrep -v '^#' $HOME/.yalo/env | xargs )

Then restart your shell, and install the Yalo CLI by running

npm install -g @engyalo/yalo-cli

Happy coding!
- The Yalo Product Team

As suggested, add the following lines to your .zshrc, .zshenv or similar:

export $(egrep -v '^#' $HOME/.yalo/env | xargs)

Then restart your shell. Check your installation by running yalo doctor.

The Yalo CLI is hosted as a private NPM package. To install it on your machine, first download and install Node.js and npm. We recommend the asdf version manager as an easy way of installing these packages in a cross-platform way. Alternatively, you can use the Node Version Manager (NVM).

You can use other Node version managers such as NVM as well.

npm install -g @engyalo/yalo-cli

Now you should be able to see the welcome screen for the Yalo CLI when you run yalo

ā–ˆā–ˆā•—   ā–ˆā–ˆā•— ā–ˆā–ˆā–ˆā–ˆā–ˆā•— ā–ˆā–ˆā•—      ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•—      ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•—ā–ˆā–ˆā•—     ā–ˆā–ˆā•—
ā•šā–ˆā–ˆā•— ā–ˆā–ˆā•”ā•ā–ˆā–ˆā•”ā•ā•ā–ˆā–ˆā•—ā–ˆā–ˆā•‘     ā–ˆā–ˆā•”ā•ā•ā•ā–ˆā–ˆā•—    ā–ˆā–ˆā•”ā•ā•ā•ā•ā•ā–ˆā–ˆā•‘     ā–ˆā–ˆā•‘
 ā•šā–ˆā–ˆā–ˆā–ˆā•”ā• ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•‘ā–ˆā–ˆā•‘     ā–ˆā–ˆā•‘   ā–ˆā–ˆā•‘    ā–ˆā–ˆā•‘     ā–ˆā–ˆā•‘     ā–ˆā–ˆā•‘
  ā•šā–ˆā–ˆā•”ā•  ā–ˆā–ˆā•”ā•ā•ā–ˆā–ˆā•‘ā–ˆā–ˆā•‘     ā–ˆā–ˆā•‘   ā–ˆā–ˆā•‘    ā–ˆā–ˆā•‘     ā–ˆā–ˆā•‘     ā–ˆā–ˆā•‘
   ā–ˆā–ˆā•‘   ā–ˆā–ˆā•‘  ā–ˆā–ˆā•‘ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•—ā•šā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•”ā•    ā•šā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•—ā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā–ˆā•—ā–ˆā–ˆā•‘
   ā•šā•ā•   ā•šā•ā•  ā•šā•ā•ā•šā•ā•ā•ā•ā•ā•ā• ā•šā•ā•ā•ā•ā•ā•      ā•šā•ā•ā•ā•ā•ā•ā•šā•ā•ā•ā•ā•ā•ā•ā•šā•ā•

The Yalo CLI is used to manage Yalo apps from the command line.

  @engyalo/yalo-cli/1.0.2 darwin-x64 node-v12.18.0

  $ yalo [COMMAND]

  addon  Add an exist addons for extending storefront

  config           Displays configuration
  create           Creates projects, packages, and add-ons
  doctor           Checks your system setup
  help             display help for yalo
  login            Logs you in to Yalo
  logout           Logs you out of Yalo
  preview          Shows a preview of the storefront that you have created
  publish          Publishes a package
  update           Checks your system setup
  upload-products  Upload products from csv file. If --dev flag is settled means that the data is going to be published in the
                   development environment and is going to be available only when the preview command is used.

~ without fear of success!

If you see this, you're done! A couple of commands worth noting:

yalo doctor

This command will check your installation point-by-point. If you run into any problems, run this command and send the output to the development team at [email protected]

yalo update

This command will update the SDK at the ~/.yalo directory, and the CLI itself.

yalo login

Logs you into Yalo to use protected commands like yalo create and yalo deploy.

Updated about a month ago

Installing the Yalo CLI

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.