# git-deploy-directory

> Deploy a directory to a git branch. You can use the configuration file to deploy easily.Useful to deploy to GitHub Pages.

Latest version **1.0.2** (published 2018-10-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install git-deploy-directory
pnpm add git-deploy-directory
yarn add git-deploy-directory
bun add git-deploy-directory
```

Provides the commands `git-deploy`, `git-deploy-init`, `git-deploy-push`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2018-10-26 |
| First published | 2018-10-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Unpacked size | 69.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | webkong |
| Maintainers | webkong |
| Keywords | git-deploy, git-deploy-directory, git, deploy, cli |

## Links

- npm: https://www.npmjs.com/package/git-deploy-directory
- Repository: https://github.com/webkong/git-deploy-directory
- Homepage: https://github.com/webkong/git-deploy-directory#readme
- Issues: https://github.com/webkong/git-deploy-directory/issues
- npm.io page: https://npm.io/package/git-deploy-directory

## Dependencies (11)

- [uid](https://npm.io/package/uid.md) 0.0.2
- [async](https://npm.io/package/async.md) ^2.4.0
- [chalk](https://npm.io/package/chalk.md) ^2.1.0
- [tildify](https://npm.io/package/tildify.md) ^1.2.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.2
- [inquirer](https://npm.io/package/inquirer.md) ^3.3.0
- [commander](https://npm.io/package/commander.md) ^2.9.0
- [handlebars](https://npm.io/package/handlebars.md) ^4.0.5
- [consolidate](https://npm.io/package/consolidate.md) ^0.14.0
- [cross-spawn](https://npm.io/package/cross-spawn.md) ^6.0.5
- [coffee-script](https://npm.io/package/coffee-script.md) 1.12.7

## 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

- 1.0.2 (latest) — 2018-10-26
- 1.0.1 — 2018-10-26

## README

English|[简体中文](./README_zh.md)

# git-deploy-directory

Deploy a directory to a git branch. You can use the configuration file to deploy easily.Useful to deploy to GitHub Pages.


### Installation

``` bash
$ npm install -D git-deploy-directory
or 
$ yarn add -D git-deploy-directory
```

### Usage
``` bash
// init 

$ git deploy init //Initialize the configuration file
```
Configuration file
```
{
  "type": "git",
  "repo": "https://github.com/webkong/xxxx.git",  // git repo
  "branch": "docs", // git branch 
  "dir": "build" // You are going to deploy directory
}
```

```
// deploy
$ git deploy push
```

### License

[MIT](http://opensource.org/licenses/MIT)


## Author

![me](https://s.gravatar.com/avatar/1fe24100ab2109076fd777d1ad0a28c5?s=100)

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