# propellantry

> ___ [![Build Status](https://travis-ci.com/anteeek/propellantry.svg?branch=master)](https://travis-ci.com/anteeek/propellantry)

Latest version **0.0.7** (published 2019-11-01) · GNU GPL 3.0 license · 0 weekly downloads

## Install

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

Provides the command `propel`.

## 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.0.7 |
| Published | 2019-11-01 |
| First published | 2019-10-31 |
| Weekly downloads | 0 |
| License | GNU GPL 3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 33 KB |
| Known vulnerabilities | 0 (+4 in 1 direct dependencies) |
| Install scripts | no |
| Author | @anteeek |
| Maintainers | antek |

## Links

- npm: https://www.npmjs.com/package/propellantry
- Repository: https://github.com/anteeek/propellantry
- Homepage: https://github.com/anteeek/propellantry#readme
- Issues: https://github.com/anteeek/propellantry/issues
- npm.io page: https://npm.io/package/propellantry

## Dependencies (5)

- [chalk](https://npm.io/package/chalk.md) ^2.4.2
- [inquirer](https://npm.io/package/inquirer.md) ^7.0.0
- [optimist](https://npm.io/package/optimist.md) ^0.6.1
- [basic-ftp](https://npm.io/package/basic-ftp.md) ^4.4.1
- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.26.0

## Recent versions

- 0.0.7 (latest) — 2019-11-01
- 0.0.6 — 2019-11-01
- 0.0.5 — 2019-11-01
- 0.0.4 — 2019-11-01
- 0.0.3 — 2019-10-31
- 0.0.2 — 2019-10-31
- 0.0.1 — 2019-10-31

## README

# Ftp propellant
___
[![Build Status](https://travis-ci.com/anteeek/propellantry.svg?branch=master)](https://travis-ci.com/anteeek/propellantry)

A very simple and basic CLI for deployment through FTP with one command.

## Usage

Firstly you have to run

`npm install -g propellantry` 

or

`yarn global add propellantry`

then you simply run 

`propel init`

to be guided through making `deployfile.json`


You will need to make a `deployfile.json` in the directory you are running the command. 

It needs to contain:

#### - `host` 
A string containing ftp server's hostname (along with port, if different than the default one.)
#### - `user` and `password`
Strings representing credentials. If no password is needed, leave it blank
#### - `directory` (object)
An object containing:
 - `local` - the directory you want to deploy (from your local machine)
Defaults to "." (the directory from where the command is ran)
 - `remote` - the directory you want to deploy to (on the remote machine)
. Defaults to "." (the root of FTP's account)

#### - `include` and `exclude` 
Arrays containing names of files that you may wish to exclude/include from 
the deployed files. Files excluded by default are `node_modules` and `.git`, 
but they can be included if you wish to (use `"include_git": true` and analogously `"include_node_modules": true`)

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