{"id":13903045,"url":"https://github.com/tunnckoCoreLabs/gitcommit","last_synced_at":"2025-07-18T00:33:09.299Z","repository":{"id":71511753,"uuid":"108808148","full_name":"tunnckoCoreLabs/gitcommit","owner":"tunnckoCoreLabs","description":"Lightweight and joyful `git commit` replacement. Conventional Commits compliant.","archived":false,"fork":false,"pushed_at":"2020-04-28T05:59:59.000Z","size":172,"stargazers_count":7,"open_issues_count":4,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-21T01:31:59.269Z","etag":null,"topics":["cli","commit","conventional-commits","git","git-commit","gitcommit"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tunnckoCoreLabs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-30T05:59:38.000Z","updated_at":"2024-01-15T17:23:11.000Z","dependencies_parsed_at":"2023-02-22T04:45:19.517Z","dependency_job_id":null,"html_url":"https://github.com/tunnckoCoreLabs/gitcommit","commit_stats":null,"previous_names":["tunnckocore/gitcommit"],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCoreLabs%2Fgitcommit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCoreLabs%2Fgitcommit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCoreLabs%2Fgitcommit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunnckoCoreLabs%2Fgitcommit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tunnckoCoreLabs","download_url":"https://codeload.github.com/tunnckoCoreLabs/gitcommit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226191076,"owners_count":17587964,"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":["cli","commit","conventional-commits","git","git-commit","gitcommit"],"created_at":"2024-08-06T22:01:35.158Z","updated_at":"2024-11-25T11:31:14.291Z","avatar_url":"https://github.com/tunnckoCoreLabs.png","language":"JavaScript","readme":"# gitcommit [![npm version][npmv-img]][npmv-url] [![github release][github-release-img]][github-release-url] [![License][license-img]][license-url]\n\n\u003e Lightweight and joyful `git commit` replacement. Conventional Commits compliant.\n\n\u003cdiv id=\"thetop\"\u003e\u003c/div\u003e\n\n_You might also be interested in [prompts][highlighted-link] or in the other [related projects](#related-projects)._\n\n## Quality Assurance :100:\n\n[![Code Style Standard][standard-img]][standard-url]\n[![Linux Build][circleci-img]][circleci-url]\n[![Code Coverage][codecov-img]][codecov-url]\n[![Dependencies Status][dependencies-img]][dependencies-url]\n[![Renovate App Status][renovate-img]][renovate-url]\n\nIf you have any _how-to_ kind of questions, please read [Code of Conduct](./CODE_OF_CONDUCT.md) and **ping me on [twitter](https://twitter.com/tunnckoCore)** or [open an issue][open-issue-url].  \nYou may also read the [Contributing Guide](./CONTRIBUTING.md). There, beside _\"How to contribute?\"_, we describe everything **_stated_** by the badges.\n\n[![Make A Pull Request][prs-welcome-img]][prs-welcome-url]\n[![Code Format Prettier][prettier-img]][prettier-url]\n[![Node Security Status][nodesecurity-img]][nodesecurity-url]\n[![Conventional Commits][ccommits-img]][ccommits-url]\n[![Semantically Released][new-release-img]][new-release-url]\n\nProject is [semantically](https://semver.org) \u0026 automatically released on [CircleCI][codecov-url] with [new-release][] and its [New Release](https://github.com/apps/new-release) Github Bot.\n\n[![All Contributors Spec][all-contributors-img]](#contributors)\n[![Newsletter Subscribe][tinyletter-img]][tinyletter-url]\n[![Give thanks][give-donate-img]][give-donate-url]\n[![Share Love Tweet][share-love-img]][share-love-url]\n[![NPM Downloads Weekly][downloads-weekly-img]][npmv-url]\n[![NPM Downloads Monthly][downloads-monthly-img]][npmv-url]\n[![NPM Downloads Total][downloads-total-img]][npmv-url]\n\n## Table of Contents\n\n- [Install](#install)\n- [API](#api)\n- [Related Projects](#related-projects)\n- [Contributing](#contributing)\n- [Contributors](#contributors)\n- [Users](#users)\n- [License](#license)\n\n## Install\n\nThis project requires [**Node.js**][nodeversion-url] **v8.6** or above. Install it using [**yarn**](https://yarnpkg.com) **v1.3+** or [**npm**](https://www.npmjs.com) **v5.2+** package managers.\n\n```\n$ yarn add gitcommit\n```\n\nOr install it globally and for example run `gitcommit --scope`. It will prompt you with questions\nfor commit type, commit scope and commit subject (short description). The type and subject questions are required always, so you can't skip them.\n\n```\n$ yarn global add gitcommit\n```\n\nAll `git commit` flags are available too.\n\n```\n# -s is --signoff, -S is --gpg-sign\n$ gitcommit -S -s --scope --body --footer\n\n# equivalent of above is following\n# where -x is --scope, -y is --body and -w is --footer\n$ gitcommit -Ssxyw\n```\n\nAbove command will GPG Sign commit, add `Sign-off-by` at the end line, prompt\nfor commit scope, body and footer. Consider we commit breaking change.\n\n```\n$ gitcommit -Ssxyw\n? Select the type of this change ›\n❯  fix:   A bug fix\n   feat:  New feature\n   major: Breaking change\n   chore: Non src or test files changes\n   docs:  Documentation only changes\n✔ What is the scope of this change? … refactor\n✔ Short, imperative tense description … huge api change\n✔ Longer description (or fixes #17423, closes #33) … some pretty long body description.\n✔ List issues or PRs (e.g. fixes #1771, resolves #371) … fixes #33, resolves #511\n```\n\nThe actual `git commit` command which will be executed is like\n\n```\n$ git commit --allow-empty-message -S -s -m \"major(refactor): huge api change\" -m \"\" -m \"some pretty long body description.\" -m \"\" -m \"fixes #33, closes #511\"\n```\n\n\u003c!-- \nA browser usage is also possible, thanks to the [unpkg.com](https://unpkg.com) CDN and [Rollup](https://ghub.now.sh/rollup) bundler.  \nSee available bundles at [`https://unpkg.com/gitcommit/dist/browser/`](https://unpkg.com/gitcommit/dist/browser/).\n\n\u003e _**Note:** May not work in the browser if some of the [Node.js builtin modules](https://github.com/juliangruber/builtins/blob/master/builtins.json) are used here._\n --\u003e\n\n## API\n\nReview carefully the provided examples and the working [tests](./test).\n\n**[back to top](#thetop)**\n\n## Related Projects\n\nSome of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance!\n- [hela-config-tunnckocore](https://www.npmjs.com/package/hela-config-tunnckocore): Shareable Config (preset of tasks) for [hela][] task runner | [homepage](https://github.com/tunnckoCore/hela-config-tunnckocore \"Shareable Config (preset of tasks) for [hela][] task runner\")\n- [new-release](https://www.npmjs.com/package/new-release): A stable alternative to [semantic-release][]. Only handles NPM publishing and nothing more… [more](https://github.com/tunnckoCore/new-release#readme) | [homepage](https://github.com/tunnckoCore/new-release#readme \"A stable alternative to [semantic-release][]. Only handles NPM publishing and nothing more. For creating GitHub releases use the Semantic Release GitHub App\")\n- [try-catch-core](https://www.npmjs.com/package/try-catch-core): Low-level package to handle completion and errors of sync or asynchronous functions… [more](https://github.com/hybridables/try-catch-core#readme) | [homepage](https://github.com/hybridables/try-catch-core#readme \"Low-level package to handle completion and errors of sync or asynchronous functions, using [once][] and [dezalgo][] libs. Useful for and used in higher-level libs such as [always-done][] to handle completion of anything.\")\n\n**[back to top](#thetop)**\n\n## Contributing\n\nPlease read the [Contributing Guide](./CONTRIBUTING.md) and [Code of Conduct](./CODE_OF_CONDUCT.md) documents for advices.  \nFor bugs reports and feature requests, [please create an issue][open-issue-url].\n\n## Contributors\n\nThanks to the hard work of [these wonderful people](./CONTRIBUTORS.md) this project is alive and it also follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification.  \n[Pull requests](https://github.com/tunnckoCore/contributing#opening-a-pull-request), stars and all kind of [contributions](https://opensource.guide/how-to-contribute/#what-it-means-to-contribute) are always welcome.\n\n## Users\n\nYou can see who uses `gitcommit` in the [USERS.md](./USERS.md) file. Please feel free adding this file if it not exists.  \nIf you or your organization are using this project, consider adding yourself to the list of users. **Thank You!**\n\n## License\n\nCopyright (c) 2017-present, [Charlike Mike Reagent][author-link] `\u003colsten.larck@gmail.com\u003e`.  \nReleased under the [Apache-2.0 License][license-url].\n\n---\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on March 07, 2018._  \n_Project automation and management with [hela][] task framework._\n\n[always-done]: https://github.com/hybridables/always-done\n[dezalgo]: https://github.com/npm/dezalgo\n[hela]: https://github.com/tunnckoCore/hela\n[new-release]: https://github.com/tunnckoCore/new-release\n[once]: https://github.com/isaacs/once\n[semantic-release]: https://github.com/semantic-release/semantic-release\n\n\u003c!-- Heading badges --\u003e\n\n[npmv-url]: https://www.npmjs.com/package/gitcommit\n[npmv-img]: https://img.shields.io/npm/v/gitcommit.svg?label=npm%20version\n\n[github-release-url]: https://github.com/tunnckoCoreLabs/gitcommit/releases/latest\n[github-release-img]: https://img.shields.io/github/release/tunnckoCoreLabs/gitcommit.svg?label=github%20release\n\n[license-url]: https://github.com/tunnckoCoreLabs/gitcommit/blob/master/LICENSE\n[license-img]: https://img.shields.io/badge/license-Apache%202.0-blue.svg\n\n\u003c!-- [license-img]: https://img.shields.io/badge/license-tunnckoCore_1%2E0-blue.svg --\u003e\n\n\u003c!-- Front line badges --\u003e\n\n[standard-url]: https://github.com/airbnb/javascript\n[standard-img]: https://img.shields.io/badge/code_style-airbnb-brightgreen.svg\n\n[circleci-url]: https://circleci.com/gh/tunnckoCoreLabs/gitcommit/tree/master\n[circleci-img]: https://img.shields.io/circleci/project/github/tunnckoCoreLabs/gitcommit/master.svg\n\n[codecov-url]: https://codecov.io/gh/tunnckoCoreLabs/gitcommit\n[codecov-img]: https://img.shields.io/codecov/c/github/tunnckoCoreLabs/gitcommit/master.svg\n\n[dependencies-url]: https://david-dm.org/tunnckoCore/gitcommit\n[dependencies-img]: https://img.shields.io/david/tunnckoCore/gitcommit.svg\n\n\u003c!-- Second front of badges --\u003e\n\n[prs-welcome-img]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg\n[prs-welcome-url]: http://makeapullrequest.com\n[prettier-url]: https://github.com/prettier/prettier\n[prettier-img]: https://img.shields.io/badge/styled_with-prettier-f952a5.svg\n\n[nodesecurity-url]: https://nodesecurity.io/orgs/tunnckocore/projects/a3213fd4-9f9a-46a1-a472-055c49331b92/master\n[nodesecurity-img]: https://nodesecurity.io/orgs/tunnckocore/projects/a3213fd4-9f9a-46a1-a472-055c49331b92/badge\n\n\u003c!-- the original color of nsp: \n[nodesec-img]: https://img.shields.io/badge/nsp-no_known_vulns-35a9e0.svg --\u003e\n\n[ccommits-url]: https://conventionalcommits.org/\n[ccommits-img]: https://img.shields.io/badge/conventional_commits-1.0.0-yellow.svg\n[new-release-url]: https://github.com/tunnckoCore/new-release\n[new-release-img]: https://img.shields.io/badge/semantically-released-05C5FF.svg\n[nodeversion-url]: https://nodejs.org/en/download\n\n[nodeversion-img]: https://img.shields.io/node/v/gitcommit.svg\n\n[renovate-url]: https://renovateapp.com\n[renovate-img]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg\n\n\u003c!-- Third badges line (After CodeSponsor.io ad) --\u003e\n\n[all-contributors-img]: https://img.shields.io/github/contributors/tunnckoCore/gitcommit.svg?label=all%20contributors\u0026colorB=ffa500\n\n[tinyletter-url]: https://tinyletter.com/tunnckoCore\n[tinyletter-img]: https://img.shields.io/badge/join-newsletter-9caaf8.svg\n\n\u003c!-- \n[paypal-donate-url]: https://paypal.me/tunnckoCore/10\n[paypal-donate-img]: https://img.shields.io/badge/$-support-f47721.svg\n --\u003e\n\n[give-donate-url]: https://paypal.me/tunnckoCore/10\n[give-donate-img]: https://img.shields.io/badge/give-donation-f47721.svg\n\n[downloads-weekly-img]: https://img.shields.io/npm/dw/gitcommit.svg\n[downloads-monthly-img]: https://img.shields.io/npm/dm/gitcommit.svg\n[downloads-total-img]: https://img.shields.io/npm/dt/gitcommit.svg\n\n\u003c!-- Miscellaneous --\u003e\n\n[share-love-url]: https://twitter.com/intent/tweet?text=https://github.com/tunnckoCore/gitcommit\u0026via=tunnckoCore\n[share-love-img]: https://img.shields.io/badge/tweet-about-1da1f2.svg\n\n[open-issue-url]: https://github.com/tunnckoCore/gitcommit/issues/new\n[highlighted-link]: https://ghub.now.sh/prompts\n[author-link]: http://tunnckocore.com\n\n","funding_links":["https://paypal.me/tunnckoCore/10"],"categories":["cli"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FtunnckoCoreLabs%2Fgitcommit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FtunnckoCoreLabs%2Fgitcommit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FtunnckoCoreLabs%2Fgitcommit/lists"}