npm package: @sumor-cloud/deployer
Description: Sumor Deployer Tool is a tool used to quickly deploy applications to the cloud.
Latest version: 1.0.0
Deprecated: outdated

# @sumor-cloud/deployer
Sumor Deployer Tool is a tool used to quickly deploy applications to the cloud.

[![NPM version](https://img.shields.io/npm/v/%40sumor-cloud%2Fdeployer.svg)](https://www.npmjs.com/package/@sumor-cloud/deployer)
[![NPM downloads](https://img.shields.io/npm/dm/%40sumor-cloud%2Fdeployer.svg)](https://www.npmjs.com/package/@sumor-cloud/deployer)

# Sumor Deployer Tool

A [Sumor Cloud](https://www.sumor.com) Tool, Sumor Deployer Tool is a tool used to quickly deploy applications to the cloud.   
[More Documentation](https://www.sumor.com/help)

## Installation

```shell
npm install -D @sumor-cloud/deployer
```

Now, you can use the `scd` command to use the deployer tool.

## Usage

### One-time Deployment
It will deploy the application to the cloud.
```shell
scd deploy
```

### Continuous Deployment
It will deploy the application to the cloud, and then listen to the changes of the local files, and automatically deploy the application to the cloud when the files are changed.
```shell
scd deploy --watch
```

### Specify Type
It specifies the configuration file type. If there has different type available, it will automatically convert to the desired target type.
```shell
scd deploy --type=yaml
```

### Display Logs
It will display the logs of the deployment.
```shell
scd logs
```

## Configuration

### scope
It defines the scope of the deployment.

##### source
* ___< source name >___
    * url: git repository url
    * username: git username
    * password: git password
##### server
* ___< server name >___
    * host: external host
    * iHost: internal host
    * port: default 22
    * username: server username
    * password: server password

##### env
* ___< environment name >___
    * ___< app name >___
        * domain: expose domain, like example.com
        * entry: should be server name
### scale
It defines the scale of the deployment. Include env, instance size and instance count.

* ___< environment name >___
    * ___< app name >___
        * ___< version >___
            * live: if true, it will be available to the public
            * instance
                * ___< server name >___: instance count


## Contributing & Issues

You can use this tool for free.  
But we are a commercial company, to ensure stability, we currently don't offer a joint contribution mechanism.  
You can report issues through [Report Library Issue Ticket](https://www.sumor.com/ticket/library), and we will fix them as soon as possible.

## License

In consideration of the chaotic situation in the open source community, we provide obfuscated code for use and security analysis.  
However, we do not provide the source code in its original form in order to protect the ongoing maintenance and creative interests and motivations.  
The released code in [NPMJS](https://www.npmjs.com) is based on MIT. The source code is closed-source.

Our tools are free to use in order to help build cloud applications more efficiently. Our commercial purpose is to improve the ecosystem of business websites.  
If there are any innovations that greatly benefit the open source community, it will be separated and contributed to the open source community.