losant-cli

Losant CLI

Description

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, Files, and Data Tables in your Applications.

Installation

The CLI requires Node.js version 8.3 or higher. The latest stable version is available in NPM and can be installed using:

npm install -g losant-cli

Usage

losant [options] [command]

Commands

• login
• configure
• experience
• files
• datatables

Login

Before you run any other commands, you will want to run losant login to authenticate with your Losant account. This will ask for the email address and password (and optionally your 2 factor code) for your Losant account, and store an authentication token on your computer.

Configure

The losant configure command configures and links the current directory to one of your Losant Applications. Once you have configured you will notice a few new directories into your current directory. There will be the following directories added:

• experience/components
• experience/pages
• experience/layouts
• files/
• dataTables/

This is how the CLI will be able to detect new files, experience views, or data tables that you want to add, update or remove from your Losant Application. The files directory will contain and reflect the directory and files on your Losant Application's Files. Similarly, the dataTables directory will contain your Losant Application's data tables as csv files. and The experience directory is broken down by view type (components, layouts and pages), e.g. if you want to create a new component add this to your components directory, or if you want to remove a page, you will find that page located under experience/pages.

Experience

The losant experience command is how you manage the Experience Views and Versions for a configured Application. It has the following subcommands:

• download
• status
• upload
• layout
• bootstrap
• version
• watch

Experience Examples

• Download all experience views (components, layouts and pages)
  $ losant experience download
• Download component views
  $ losant experience download --type components
• Download component views with names that start with error
  $ losant experience download --type components error*
• Force a download of all views overwriting local modifications
  $ losant experience download -f
• Check status of all experience views
  $ losant experience status
• Upload all experience views
  $ losant experience upload
• Upload only component views
  $ losant experience upload --type components /*
• List all of your current experience versions
  $ losant experience version
• List all of your experience versions that match a pattern
  $ losant experience version -l v1.*
• Create a new experience version
  $ losant experience version v1.0.0
• Create a new experience version with a description
  $ losant experience version v1.0.1 -d "updated home page"
• Watch your Experience while you make changes and have them automatically uploaded
  $ losant experience watch
• View all your experience pages with their layouts
  $ losant experience layout
• View all of your experience pages that match this pattern with their layout
  $ losant experience layout -l v1.*
• View all your experience pages with their layouts
  $ losant experience layout
• To generate our standard experience starter views
  $ losant experience bootstrap

Files

The losant files command is how you manage the files for a configured Application. It has the following subcommands:

• download
• status
• upload
• watch

Files Examples

• Download all files
  $ losant files download
• Download files in images directory
  $ losant files download images/*
• Force a download of all files overwriting local modifications
  $ losant files download -f
• Check status of all files
  $ losant files status
• Upload all files
  $ losant files upload
• Upload files in images directory
  $ losant files upload images/*
• Force an upload of all files overwriting remote modifications
  $ losant files upload -f
• Watch your Files while you make changes and have them automatically uploaded
  $ losant files watch

Data Tables

The losant datatables command is how you manage the data tables for a configured Application. It has the following subcommands:

• export

Data Tables Examples

• Export all data tables
  $ losant datatables export
• Export all data tables whose names start with Chicago
$ losant datatables export Chicago
• Force a export of all data tables overwriting local modifications
  $ losant datatables export -f

---

Copyright (c) 2019 Losant IoT, Inc

https://www.losant.com

Changelog

Losant CLI v1.2.2

Fixed

• sanitizing experience file names

--