# ngdeploy

> Deploying SPA's and Static pages into the cloud.

Latest version **0.4.6** (published 2016-07-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install ngdeploy
pnpm add ngdeploy
yarn add ngdeploy
bun add ngdeploy
```

Provides the command `ngdeploy`.

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.6 |
| Published | 2016-07-20 |
| First published | 2016-06-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.8 |
| Dependencies | 12 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Milos Bejda |
| Maintainers | marek5050 |
| Keywords | cli, command line, deployment, angular |

## Links

- npm: https://www.npmjs.com/package/ngdeploy
- Repository: https://github.com/ngdeployio/ngdeploy
- Homepage: https://github.com/NGDeployio/ngdeploy
- Issues: https://github.com/ngdeployio/ngdeploy/issues
- npm.io page: https://npm.io/package/ngdeploy

## Dependencies (12)

- [s3](https://npm.io/package/s3.md) 4.4.0
- [open](https://npm.io/package/open.md) 0.0.5
- [chalk](https://npm.io/package/chalk.md) ^1.1.1
- [sinon](https://npm.io/package/sinon.md) ^1.17.4
- [prompt](https://npm.io/package/prompt.md) ^1.0.0
- [request](https://npm.io/package/request.md) ^2.72.0
- [winston](https://npm.io/package/winston.md) ^2.2.0
- [cli-table](https://npm.io/package/cli-table.md) ^0.3.1
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [underscore](https://npm.io/package/underscore.md) ^1.8.3
- [single-line-log](https://npm.io/package/single-line-log.md) ^1.1.1
- [sinon-as-promised](https://npm.io/package/sinon-as-promised.md) ^3.0.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.4.6 (latest) — 2016-07-20
- 0.4.3 — 2016-07-20
- 0.4.0 — 2016-07-20
- 0.3.4 — 2016-07-17
- 0.3.2 — 2016-07-17
- 0.3.1 — 2016-07-12
- 0.3.0 — 2016-07-11
- 0.2.9 — 2016-07-11
- 0.2.8 — 2016-07-11
- 0.2.7 — 2016-07-11
- 0.2.6 — 2016-07-08
- 0.2.5 — 2016-07-08
- 0.2.4 — 2016-07-08
- 0.2.3 — 2016-06-30
- 0.2.2 — 2016-06-29
- … 5 more at https://npm.io/package/ngdeploy/versions

## README

# ngDeploy CLI 

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
[![TravisCI Status](https://travis-ci.org/NGDeployio/ngDeploy.svg)](https://travis-ci.org/NGDeployio)
[![bitHound Overall Score](https://www.bithound.io/github/NGDeployio/ngDeploy/badges/score.svg)](https://www.bithound.io/github/NGDeployio/ngDeploy)
[![https://david-dm.org/ngdeployio/ngdeploy](https://david-dm.org/ngdeployio/ngdeploy.svg)](https://david-dm.org/ngdeployio/ngdeploy)
 
[![Grunt](https://img.shields.io/badge/✔-Grunt-brightgreen.svg?style=flat-square)](http://ngdeploy.com/docs/grunt)
[![Bower](https://img.shields.io/badge/✔-Bower-brightgreen.svg?style=flat-square)](http://ngdeploy.com/docs/bower)
[![Github](https://img.shields.io/badge/✔-Github-brightgreen.svg?style=flat-square)](http://ngdeploy.com/docs/github)


***

## Installation

Install this globally and you'll have access to the `ngdeploy` command anywhere on your system.

```shell
[sudo] npm install -g ngdeploy
```

## Usage

```shell
$ ngdeploy --help
1.    $ ngdeploy login -g
2.    $ ngdeploy create <appName>
3.    $ ngdeploy init <appName> <distDir>
4.    $ ngdeploy push
Example: 
1.    $ ngdeploy login -g
2.    $ ngdeploy create helloApp
3.    $ ngdeploy init helloApp ./dist
4.    $ ngdeploy push
```

## Getting Started

### 1. Login
[Register or log into ngDeploy.](https://ngdeploy.com/#!/?redirectTo=private.accounts) Which will create an ngDeploy account and initiate the hosting process. 
To authenticate the terminal copy and paste the account token from the profile page. 

**Format**

> ngdeploy login -g 

**Example**

```shell
$ ngdeploy login -g 
$ prompt: Open this link in a browser to register: https://ngdeploy.com/#!/?redirectTo=private.accounts
$ prompt: Account Token to use:  **************
```

### 2. Create
Creating your first application is as easy as:

**Format**  

> ngdeploy create \<Application Name> 

**Example**  

```shell
$ ngdeploy create HelloWorld
```

> Please note application names must be publicly unique.

### 3. Initialize
Now we can initialize the **.ngdeploy** configuration file using **init**. **.ngdeploy** also holds the Account Token
, Distribution directory, Application name, and in the future additional configuration information.

**Format**

> ngdeploy init \<Application Name> \<Distribution directory>

**Example**

```shell
ngdeploy init HelloWorld .  
```

### 4. Push
Push synchronizes the **Distribution directory** with our cloud. It'll compare the MD5 hash of 
the files with what's currently stored in the cloud and only upload files that have changed.

**Format**

> ngdeploy push

**Example**  

```shell
ngdeploy push
```

## Commands

**The command `ngdeploy --help` lists the available commands and `ngdeploy <command> --help` displays additional information about a command.**

For project-specific commands, you must be inside a project directory with an
active `.ngdeploy` file.

Below is a brief list of the available commands and their function:

### Commands

Command | Description
------- | -----------
**login** | Authenticate the terminal with ngDeploy
**logout** | Destroy the authentication information
**https** | Commands for managing the HTTPs functionality
**domain** |  For managing the domains of an app
**list** | Print a list of all of your ngDeploy apps
**help** | Display help information about the CLI or specific commands

### Custom Domain
<!--Additional documentation can be found at http://ngdeploy.com/docs/custom-domains.-->

**Format**

> $ ngdeploy domain add --domain \<domain> --appId \<appId>   /

**Example**

```shell
$ ngdeploy domain add --domain ngdeploy.com --appId 10
```

### SSL for HTTPS
<!--Additional documentation can be found at http://ngdeploy.com/docs/https-support.-->

**Format**

> $ ngdeploy ssl add -k \<path to key>  

**Example**

```shell
$ ngdeploy ssl add -k .private_key.ssl
```


### Environment
<!--Additional documentation can be found at http://ngdeploy.com/docs/environment.-->

Environmental variables can be injected into a SPA using the setEnv command. Upon a 
user request this embeds a javascript file with the given environmental variables. 

**Format** 
> ngdeploy setEnv \<Application Id> \<Stage> \<key:val>

**Example**
```shell
ngdeploy setEnv 1 production key:val
```

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