# remote-deployer

> A tool to run scripts on a remote server.

Latest version **0.3.8** (published 2018-11-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install remote-deployer
pnpm add remote-deployer
yarn add remote-deployer
bun add remote-deployer
```

Provides the command `deployer`.

## 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.3.8 |
| Published | 2018-11-16 |
| First published | 2018-10-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 17 |
| Unpacked size | 68.6 KB |
| Known vulnerabilities | 0 (+7 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Nir Adler |
| Maintainers | niradler55 |
| Keywords | remote-deployer, deployer, ssh, http, deploy, deployment |

## Links

- npm: https://www.npmjs.com/package/remote-deployer
- Repository: https://github.com/niradler/deployer
- Homepage: https://github.com/niradler/remote-deployer
- Issues: https://github.com/niradler/remote-deployer/issues
- npm.io page: https://npm.io/package/remote-deployer

## Dependencies (17)

- [clui](https://npm.io/package/clui.md) ^0.3.6
- [ssh2](https://npm.io/package/ssh2.md) ^0.6.1
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [clear](https://npm.io/package/clear.md) ^0.1.0
- [colors](https://npm.io/package/colors.md) ^1.3.2
- [figlet](https://npm.io/package/figlet.md) ^1.2.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [morgan](https://npm.io/package/morgan.md) ^1.9.1
- [express](https://npm.io/package/express.md) ^4.16.4
- [shelljs](https://npm.io/package/shelljs.md) ^0.8.2
- [inquirer](https://npm.io/package/inquirer.md) ^6.2.0
- [node-ssh](https://npm.io/package/node-ssh.md) ^5.1.2
- [commander](https://npm.io/package/commander.md) ^2.19.0
- [babel-core](https://npm.io/package/babel-core.md) ^6.26.3
- [simple-git](https://npm.io/package/simple-git.md) ^1.107.0
- [configstore](https://npm.io/package/configstore.md) ^4.0.0
- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.26.0

## Recent versions

- 0.3.8 (latest) — 2018-11-16
- 0.3.7 — 2018-11-14
- 0.3.6 — 2018-11-14
- 0.3.5 — 2018-11-11
- 0.3.4 — 2018-11-11
- 0.3.3 — 2018-11-11
- 0.3.2 — 2018-11-10
- 0.3.0 — 2018-11-10
- 0.2.7 — 2018-11-09
- 0.2.6 — 2018-11-08
- 0.2.5 — 2018-11-08
- 0.2.4 — 2018-11-08
- 0.2.3 — 2018-11-08
- 0.2.2 — 2018-11-08
- 0.2.1 — 2018-11-07
- … 5 more at https://npm.io/package/remote-deployer/versions

## README

# Remote Deployer

***Deployer*** is an npm package to deploy to a remote server.

- deploy with ssh: connect to the server and run command from a script, good for running from client or build server.
- deploy with http: create get request with secret key to fire deploy process (preconfigure script run), to set up on the remote server.
- deploy with ftp: coming soon.

***
 Used by me at [devresources](https://devresources.site/), 
 helping me to setup ci/cd with gitlab worker.
***

### Setup

```
npm i -g remote-deployer
```

### API

- ```deployer -h //show help file```
- ```deployer ssh -h //show sub help file```
- ```deployer init```

### Notes

- to support multi configuration, you need to make sure the default_id key in the config is not set. (you need to run the commands in the project folder)
- to support running deployer from anywhere but support only one configuration make sure default_id is set.
- on linux and mac, make sure the script as permission, ```chmod +x script.sh```
- get config file path: ```deployer config path```
- print config file: ```deployer config all```
- try running deployer in the project folder. (deployer will interact with git to save release date/data support ssh only)
- trigger example for deployer http: ```curl http://api.site.site:1234/deploy?appKey=bdd110130eg51a5e8ac15b829e336f7710e3ba71```
- read the blog [post](https://niradler.com/introduction-remote-deployer/).

### TODO

- restore to last deployed commit and deploy.
- ftp deploy

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