# @chatty-webviews/cli

> Chatty Webviews Releases CLI

Latest version **0.0.1** (published 2023-06-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install @chatty-webviews/cli
pnpm add @chatty-webviews/cli
yarn add @chatty-webviews/cli
bun add @chatty-webviews/cli
```

Provides the command `chatty`.

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2023-06-16 |
| First published | 2023-06-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=12.0.0 |
| Dependencies | 15 |
| Unpacked size | 36.3 KB |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Vladimir Mutafov @vmutafov |
| Maintainers | vmutafov |
| Keywords | oclif |

## Links

- npm: https://www.npmjs.com/package/@chatty-webviews/cli
- Repository: https://github.com/ChattyWebviews/chatty-webviews-cli
- Homepage: https://chattywebviews.com/
- Issues: https://github.com/ChattyWebviews/chatty-webviews-cli/issues
- npm.io page: https://npm.io/package/@chatty-webviews/cli

## Dependencies (15)

- [api](https://npm.io/package/api.md) ^5.0.7
- [open](https://npm.io/package/open.md) ^9.1.0
- [adm-zip](https://npm.io/package/adm-zip.md) ^0.5.10
- [express](https://npm.io/package/express.md) ^4.18.2
- [firebase](https://npm.io/package/firebase.md) 9.17.2
- [inquirer](https://npm.io/package/inquirer.md) ^9.1.4
- [rev-hash](https://npm.io/package/rev-hash.md) ^4.0.0
- [@oclif/core](https://npm.io/package/@oclif/core.md) ^2
- [@types/inquirer](https://npm.io/package/@types/inquirer.md) ^9.0.3
- [http-terminator](https://npm.io/package/http-terminator.md) ^3.2.0
- [recursive-readdir](https://npm.io/package/recursive-readdir.md) ^2.2.3
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^5
- [@oclif/plugin-plugins](https://npm.io/package/@oclif/plugin-plugins.md) ^2.4.0
- [@vmutafov/firebase-auth-node-browser](https://npm.io/package/@vmutafov/firebase-auth-node-browser.md) ^0.1.0
- [@vmutafov/firebase-auth-node-persistence](https://npm.io/package/@vmutafov/firebase-auth-node-persistence.md) ^0.1.1

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2023-06-16

## README

Chatty WebViews CLI
=================

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/oclif-hello-world.svg)](https://npmjs.org/package/oclif-hello-world)

# 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:
```Bash
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](https://github.com/ChattyWebviews/chatty-webviews-backend).

<!-- toc -->
* [Description](#description)
* [Infrastructure setup](#infrastructure-setup)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
<!-- usage -->
```sh-session
$ 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
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`chatty ci release`](#chatty-ci-release)
* [`chatty help [COMMANDS]`](#chatty-help-commands)
* [`chatty init`](#chatty-init)
* [`chatty release`](#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](https://github.com/oclif/plugin-help/blob/v5.2.8/src/commands/help.ts)_

## `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](https://github.com/ChattyWebviews/chatty-webviews-cli/blob/v0.0.1/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](https://github.com/ChattyWebviews/chatty-webviews-cli/blob/v0.0.1/dist/commands/release/index.ts)_
<!-- commandsstop -->

---
_Source: https://npm.io/package/@chatty-webviews/cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._