{"id":18575269,"url":"https://github.com/brocessing/ghp","last_synced_at":"2025-04-10T08:30:45.902Z","repository":{"id":43288343,"uuid":"81387980","full_name":"brocessing/ghp","owner":"brocessing","description":":package: Automagically deploy your app on Github pages","archived":false,"fork":false,"pushed_at":"2022-07-06T15:50:20.000Z","size":91,"stargazers_count":8,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-24T18:46:59.791Z","etag":null,"topics":["deployment","github-pages","static-site"],"latest_commit_sha":null,"homepage":"https://brocessing.github.io/ghp/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brocessing.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-08T23:44:18.000Z","updated_at":"2022-07-06T15:49:32.000Z","dependencies_parsed_at":"2022-08-24T16:52:11.433Z","dependency_job_id":null,"html_url":"https://github.com/brocessing/ghp","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brocessing%2Fghp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brocessing%2Fghp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brocessing%2Fghp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brocessing%2Fghp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brocessing","download_url":"https://codeload.github.com/brocessing/ghp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248185218,"owners_count":21061474,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["deployment","github-pages","static-site"],"created_at":"2024-11-06T23:18:24.028Z","updated_at":"2025-04-10T08:30:45.606Z","avatar_url":"https://github.com/brocessing.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/brocessing/ghp/raw/master/assets/logo.gif\" alt=\"logo\"\u003e\n\u003c/p\u003e\n\u003ch1 align=\"center\"\u003eghp\u003c/h1\u003e\n\u003ch3 align=\"center\"\u003eAutomagically deploy your app on Github pages\u003c/h3\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003c!-- License --\u003e\n  \u003ca href=\"https://raw.githubusercontent.com/brocessing/ghp/master/LICENSE\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square\" alt=\"License\" /\u003e\n  \u003c/a\u003e\n  \u003c!-- Standard --\u003e\n  \u003ca href=\"http://standardjs.com/\"\u003e\n    \u003cimg src=\"https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square\" alt=\"Standard\" /\u003e\n  \u003c/a\u003e\n  \u003c!-- npm version --\u003e\n  \u003ca href=\"https://www.npmjs.com/package/ghp\"\u003e\n    \u003cimg src=\"https://img.shields.io/npm/v/ghp.svg?style=flat-square\" alt=\"Standard\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n\u003cbr\u003e\n\u003cbr\u003e\n\u003cbr\u003e\n\n## CLI\n\n### installation\n```sh\nnpm install -g ghp\n```\n\n### usage\n```\nghp\nghp DIRECTORY\nghp DIRECTORY --force\nghp DIRECTORY --cache \u003ccacheDirectory\u003e\nghp DIRECTORY --message \u003cmsg\u003e\nghp DIRECTORY --branch gh-pages\nghp DIRECTORY --append \u003csomeDirectoryOrFiles\u003e\nghp --help\n\nOptions:\n  -h, --help              Show this screen.\n  -b, --branch=\u003cbranchName\u003e\n                          Specify the branch to deploy to (default: gh-pages).\n  -m, --message=\u003cmsg\u003e     Use the given \u003cmsg\u003e as the commit message.\n  -a, --append=\u003cdir\u003e      Copy to the pushed directory another directory.\n  -f, --force             Deploy without checking for uncommited changes.\n  -q, --quiet             Suppress step summary messages.\n  -c, --cache=\u003ccacheDir\u003e  Specify a cache directory.\n\n```\n\n## Node.js\n\n### installation\n```sh\nnpm install -S ghp\n```\n\n### usage\n```js\nvar ghp = require('ghp')\nghp.deploy(path, options)\n```\n\n### options\n\n+ **`options.branch`**\n  + branch to deploy to\n  + *default `'gh-pages'`*\n\n+ **`options.message`**\n  + commit message for the gh-pages branch\n  + *default `':package: Update gh-pages'`*\n\n+ **`options.append`**\n  + append to the root of the pushed directory another path\n  + *default `false`*\n\n+ **`options.quiet`**\n  + suppress step summary messages\n  + *default `false`*\n\n+ **`options.force`**\n  + skip the uncommited changes step\n  + *default `false`*\n\n+ **`options.cwd`**\n  + git cwd\n  + *default `process.cwd()`*\n\n\n\n## License\n[MIT](https://tldrlegal.com/license/mit-license).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrocessing%2Fghp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrocessing%2Fghp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrocessing%2Fghp/lists"}