Losant CLI

Losant CLI is a command line tool to help manage your Losant Application and its resources. It easily lets you manage Experience Views, Experience Versions, Data Tables, and Files in your Applications.

Installation

The Losant CLI requires you to download and install Node.js version 8.3 or higher and NPM. You can use the Node installer to install both Node and NPM. Once you have those installed, run npm install -g losant-cli. To check that you have install Losant CLI properly run losant --help, and that will print all of the commands you have available. See our GitHub repository if you are having trouble installing.

Usage

Here are all the following resources the CLI supports:

Setup

Before you get started, there are a couple things you have to configure first:

Login

The first command that you need to run after install the Losant CLI is losant login.

Losant Login

This will prompt you to enter your Losant Email, Password, and Two-Factor Authentication. Your email and password is required, to complete the login. If you do not have two-factor authentication enabled, just hit enter to skip two-factor authentication.

Once you have successfully authenticated with our API, a file will be created at ~/.losant/.credentials.yml containing your authentication token. This token will be used across all of your Losant configured directories.

Losant Success Login

If authentication fails you will be prompted to re-enter your email, password and two-factor authentication.

Losant Retry Login

Configure

After you have run the losant login command successfully, you are now ready to configure a directory.

Create or go to a directory that you want to keep your Losant Application resources, then run losant configure. This will link the current directory to one of your Losant Applications.

Losant Configure

When you run this command, you will be prompted to give a (or part of a) Losant Application name. If multiple Applications come back with similar names we will present you with a list to choose from. If you don’t find the application you are looking for, choose none of these, search again, and it will re-prompt you for another Application name.

Once you have picked the Losant Application, it will automatically try to download your Application’s Experience Views. It will then prompt you to download your Application’s Files followed by your Application’s Data Tables.

Losant Configure Success

Once you have configured the directory, you will notice a few newly created directories in your configured directory.

Losant CLI Directories

  • .losant/ - this is where we store dotfiles with your YAML configuration
  • dataTables/ - this is where all of your local data tables will be stored as csv files.
  • experience/components/ - this is where all of your local experience components will be.
  • experience/pages/ - this is where all of your local experience pages will be.
  • experience/layouts/ - this is where all of your local experience layouts will be.
  • files/ - this is where all of your local files will be. The Files directory will match the top-level directory on your Application’s Files, e.g., if on Losant you have a file at /foo/bar/helloworld.txt that file will be downloaded and placed at files/foo/bar/helloworld.txt.