# ghpages

> A command-line tool to easily deploy your current working branch to GitHub Pages.

Latest version **0.0.10** (published 2017-02-10) · MIT license · 0 weekly downloads

## Install

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

Provides the command `ghpages`.

## 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.10 |
| Published | 2017-02-10 |
| First published | 2015-12-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Chris Van |
| Maintainers | cvan |
| Keywords | ghpages, gh-pages, github-pages, github, deploy, push, cli |

## Links

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

## Dependencies (6)

- [opn](https://npm.io/package/opn.md) ^3.0.3
- [meow](https://npm.io/package/meow.md) ^3.6.0
- [gh-pages](https://npm.io/package/gh-pages.md) ^0.11.0
- [object-assign](https://npm.io/package/object-assign.md) ^4.0.1
- [gitconfiglocal](https://npm.io/package/gitconfiglocal.md) ^1.0.0
- [parse-github-url](https://npm.io/package/parse-github-url.md) ^0.2.1

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

- 0.0.10 (latest) — 2017-02-10
- 0.0.9 — 2017-02-09
- 0.0.8 — 2016-04-21
- 0.0.7 — 2016-04-21
- 0.0.6 — 2016-04-21
- 0.0.5 — 2016-04-21
- 0.0.4 — 2016-04-21
- 0.0.3 — 2015-12-04
- 0.0.2 — 2015-12-04
- 0.0.1 — 2015-12-03
- 0.0.0 — 2015-12-03

## README

# ghpages

A command-line tool to easily deploy your current working branch to GitHub Pages.


## CLI Usage

```
Usage
  $ ghpages

Options
  -p, --path    Path (directory to push; defaults to current directory)
  -r, --repo    Repository (GitHub username, GitHub username/repo, full repo URL)
  -d, --domain  Domain name (for `CNAME` to create in GitHub Pages branch)
  -p, --path    Path or directory to publish. Defaults to root directory of project.
  -h, --help    Show help

Examples
  $ ghpages
  $ ghpages cvan
  $ ghpages cvan/blog
  $ ghpages cvan/blog -p dist
  $ ghpages git@github.com:cvan/blog.git
  $ ghpages -r cvan/blog -d blog.cvan.io
```


## License

[MIT](LICENSE)


## Credits

This utility mostly wraps the fantastic [`gh-pages` package](https://github.com/tschaub/gh-pages).

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