WEGnology CLI

Description

WEGnology CLI is a command line tool to help manage your WEGnology 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 wegnology-cli

Usage

wegnology [options] [command]

Commands

• login
• set-token
• configure
• experience
• files
• datatables

Login

Before you run any other commands, you must run wegnology login to authenticate with your WEGnology account. This command checks to see if your account is linked to a Single Sign-On (SSO) provider. If so, the command will prompt for a User Token; otherwise it will prompt for the password (and optionally your two-factor code) for your WEGnology account. After either is given successfully, the command will store the authentication token on your computer.

Set-token

The set-token command, wegnology set-token, is an alternative way to log in for those users whose account is linked to a Single Sign-On (SSO) provider. This will take the given token, verify that token against the API, and then set it on your user configuration file.

Configure

The wegnology configure command configures and links the current directory to one of your WEGnology 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 WEGnology Application. The files directory will contain and reflect the directory and files on your WEGnology Application's Files. Similarly, the dataTables directory will contain your WEGnology 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 wegnology 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)
  $ wegnology experience download
• Download component views
  $ wegnology experience download --type components
• Download component views with names that start with error
  $ wegnology experience download --type components error*
• Force a download of all views overwriting local modifications
  $ wegnology experience download -f
• Check status of all experience views
  $ wegnology experience status
• Upload all experience views
  $ wegnology experience upload
• Upload only component views
  $ wegnology experience upload --type components /*
• List all of your current experience versions
  $ wegnology experience version
• List all of your experience versions that match a pattern
  $ wegnology experience version -l v1.*
• Create a new experience version
  $ wegnology experience version v1.0.0
• Create a new experience version with a description
  $ wegnology experience version v1.0.1 -d "updated home page"
• Watch your Experience while you make changes and have them automatically uploaded
  $ wegnology experience watch
• View all your experience pages with their layouts
  $ wegnology experience layout
• View all of your experience pages that match this pattern with their layout
  $ wegnology experience layout -l v1.*
• View all your experience pages with their layouts
  $ wegnology experience layout
• To generate our standard experience starter views
  $ wegnology experience bootstrap

Files

The wegnology 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
  $ wegnology files download
• Download files in images directory
  $ wegnology files download images/*
• Force a download of all files overwriting local modifications
  $ wegnology files download -f
• Check status of all files
  $ wegnology files status
• Upload all files
  $ wegnology files upload
• Upload files in images directory
  $ wegnology files upload images/*
• Force an upload of all files overwriting remote modifications
  $ wegnology files upload -f
• Watch your Files while you make changes and have them automatically uploaded
  $ wegnology files watch

Data Tables

The wegnology 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
  $ wegnology datatables export
• Export all data tables whose names start with Chicago
$ wegnology datatables export Chicago
• Force a export of all data tables overwriting local modifications
  $ wegnology datatables export -f

Copyright (c) 2019 WEGnology

https://docs.app.wnology.io/getting-started/what-is-wegnology/