# ghpg

> ghpg ====

Latest version **2.0.0** (published 2020-11-26) · MIT license · 0 weekly downloads

## Install

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

Provides the command `ghpg`.

## 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 | 2.0.0 |
| Published | 2020-11-26 |
| First published | 2017-08-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=12 |
| Dependencies | 3 |
| Unpacked size | 14.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | akx |

## Links

- npm: https://www.npmjs.com/package/ghpg
- Repository: https://github.com/akx/ghpg
- Issues: https://github.com/akx/ghpg/issues
- npm.io page: https://npm.io/package/ghpg

## Dependencies (3)

- [glob](https://npm.io/package/glob.md) ^7.1.6
- [unorm](https://npm.io/package/unorm.md) ^1.6.0
- [commander](https://npm.io/package/commander.md) ^6.2.0

## Recent versions

- 2.0.0 (latest) — 2020-11-26
- 1.0.1 — 2017-08-01
- 1.0.0 — 2017-08-01

## README

ghpg
====

Easily publish a directory to `gh-pages` (or another branch really).

Inspired by [tschaub/gh-pages](https://github.com/tschaub/gh-pages).

Implemented using [git-fast-import](https://git-scm.com/docs/git-fast-import),
so there is no intermediate checkout step or cache shenanigans.

## Usage

The command-line usage and parameter naming of `ghpg` mirrors that of `gh-pages`,
but the branch is *not pushed by default* (use `--push` for that).

```

  Usage: ghpg [options]


  Options:

    -V, --version            output the version number
    -d, --dist <dist>        Source directory
    -s, --src <src>          Minimatch pattern for publishable files
    -b, --branch <branch>    Branch to create commit in
    -e, --dest <dest>        Target directory within the destination branch
    -a, --add                Only add, and never remove existing files
    -m, --message <message>  Commit message
    -g, --tag <tag>          Add tag to commit
    -o, --remote <name>      The name of the remote (if pushing)
    -p, --push               Push the branch after creating the commit
    -h, --help               output usage information
```

### Programmatic usage

The bits and pieces `ghpg` uses to do its magic are modularized and promise-based; see `bin/ghpg` how to use them.

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