@chatty-webviews/cli

Chatty WebViews CLI

Description

Chatty Webviews' CLI allows you to release over-the-air updates to users with just a few commands. You can easily distribute new application versions to your users without going through Google's Play Store or Apple's AppStore. Using this CLI is especially helpful when you want to release critical security fixes or other application updates.

Infrastructure setup

As the Chatty Webviews CLI is fully free and open source, in order to use it, you should set up your own Firebase account for storing the metadata and content of new application releases. After setting up a Firebase account, be sure to define the following environment variables on your machine or CI/CD pipeline for the CLI:

export FIREBASE_API_KEY="<your_api_key>"
export FIREBASE_AUTH_DOMAIN="<your_auth_domain>"
export FIREBASE_PROJECT_ID="<your_project_id>"
export FIREBASE_STORAGE_BUCKET="<your_storage_bucket>"
export FIREBASE_APP_ID="<your_app_id>"

The exact variable values could be easily found by going into your Firebase account's Project settings and creating a new web app using the Add app button.

After that, if you haven't already, you should enable the Authentication, Firestore Database, and Storage services by following the exact steps in Firebase.

The last bit of configuring the necessary infrastructure is deploying the Chatty Webviews backend by following its README.

• Description
• Infrastructure setup
• Usage
• Commands

Usage

$ npm install -g @chatty-webviews/cli
$ chatty COMMAND
running command...
$ chatty (--version)
@chatty-webviews/cli/0.0.1 darwin-arm64 node-v16.16.0
$ chatty --help [COMMAND]
USAGE
  $ chatty COMMAND
...

Commands

• chatty ci release
• chatty help [COMMANDS]
• chatty init
• chatty release

chatty ci release

Relase a new version of a ChattyWebViews application or module from a CI/CD environment by passing all the required parameters

USAGE
  $ chatty ci release --version <value> [--name <value>] [--modules <value>]

FLAGS
  --modules=<value>...  Release only a set of modules by their names as specified in the `chatty-webviews.json` file.
  --name=<value>        Release name. Defaults to '' if not provided.
  --version=<value>     (required) Release version.

DESCRIPTION
  Relase a new version of a ChattyWebViews application or module from a CI/CD environment by passing all the required
  parameters

EXAMPLES
  $ chatty ci release --version 12.1

  $ chatty ci release --version 12.1 --name 'test release'

  $ chatty ci release --version 12.1 --name 'test release' --modules moduleA moduleB

chatty help [COMMANDS]

Display help for chatty.

USAGE
  $ chatty help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for chatty.

See code: @oclif/plugin-help

chatty init

Initialize the configurations for a ChattyWebViews application

USAGE
  $ chatty init

DESCRIPTION
  Initialize the configurations for a ChattyWebViews application

EXAMPLES
  $ chatty init

See code: dist/commands/init/index.ts

chatty release

Relase a new version of a ChattyWebViews application or module

USAGE
  $ chatty release

DESCRIPTION
  Relase a new version of a ChattyWebViews application or module

EXAMPLES
  $ chatty release

See code: dist/commands/release/index.ts