@rampjs/cli

<!-- ⚠️ This README has been generated from the file(s) "blueprint.md" ⚠️--><h1 align="center">@rampjs/cli</h1>

<p align="center">
  <img src="https://enlythealth.com/wp-content/themes/ramp-framework/lib/img/eh-logo.svg" alt="Logo" width="200" height="auto" />
</p>

[![npm](https://img.shields.io/badge/npm-0.24.0-green.svg)](https://www.npmjs.com/package/@rampjs/cli)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://bitbucket.org/enlythealth/enlyt-health-mono/commits/)


[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#table-of-contents)

## Table of Contents

* [Purpose](#purpose)
* [Configuration](#configuration)
* [Deployment](#deployment)
* [Usage](#usage)
	* [Installation](#installation)
	* [Commands](#commands)


[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#purpose)

# Purpose

Purpose of RAMP CLI is to simplify configuration & running processes of Enlyt Health Platform packages.

This tool will help you with:
- the configuration of your machine (see `ramp doctor` commands),
- setting up the access to Enlyt Health Cloud repositories used for deployment,
- configuring the signing for both iOS & Android,
- configuring the Enlyt Health Platform,
- running Mobile & Web projects locally,
- building & deploying apps to Stores from your local machine,
- and many more ...

Besides all of that, RAMP CLI is also used on CI/CD to securely read & provide the configuration to the builds process(es) in the Cloud.


[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#configuration)

# Configuration

You don't need to configure anyting to use the tool.

[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#deployment)

# Deployment

This package is deployed to [npm](https://npmjs.com) and can be found at this URL:
- https://www.npmjs.com/package/@rampjs/cli

In order to deploy this package to **npm**, you can use the following command:
```shell
npm publish --dry-run # to test the deployment without actually deploying the package
npm publish --access public [--registry http://registry.npmjs.org] # to deploy the package
```

Make sure you're trying to deploy higher version of the package, otherwise the deployment will fail.


[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#usage)

# Usage


[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#installation)

## Installation

```shell
$ npm install -g @rampjs/cli
```


[![-----------------------------------------------------](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/colored.png)](#commands)

## Commands
- [System configuration using `ramp doctor`](docs/commands/doctor)
- [Authentication using `ramp auth`](docs/commands/auth)
- [Environment management using `ramp env`](docs/commands/env)
- [Repository management using `ramp repo`](docs/commands/repo)
- [Configuration using `ramp config`](docs/commands/config)
- [Development using `ramp dev`](docs/commands/dev)
- [Mobile signing management using `ramp signing`](docs/commands/signing)
- [Mobile builds using `ramp build`](docs/commands/build)
- [Mobile deployment using `ramp bitrise`](docs/commands/bitrise)
- [User management using `ramp user`](docs/commands/user)