ngDeploy CLI

---

Installation

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

[sudo] npm install -g ngdeploy

Usage

$ 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. 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

$ 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

$ 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

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

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

Format

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

Example

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

SSL for HTTPS

Format

$ ngdeploy ssl add -k <path to key>

Example

$ ngdeploy ssl add -k .private_key.ssl

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

ngdeploy setEnv 1 production key:val