# @conventional-changelog/git-client

> Simple git client for conventional changelog packages.

Latest version **3.1.2** (published 2026-08-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install @conventional-changelog/git-client
pnpm add @conventional-changelog/git-client
yarn add @conventional-changelog/git-client
bun add @conventional-changelog/git-client
```

## Health

**Score 60/100 (C)** — status: active.

Positive: esm support; no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 3.1.2 |
| Published | 2026-08-10 |
| First published | 2024-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Node | >=22 |
| Dependencies | 3 |
| Unpacked size | 44.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 8511 |
| Author | Dan Onoshko |
| Maintainers | bcoe, oss-bot, dangreen |
| Keywords | git, client, conventional, changelog |

## Links

- npm: https://www.npmjs.com/package/@conventional-changelog/git-client
- Repository: https://github.com/conventional-changelog/conventional-changelog
- Homepage: https://conventional-changelog.js.org/git-client/
- Issues: https://github.com/conventional-changelog/conventional-changelog/issues
- npm.io page: https://npm.io/package/@conventional-changelog/git-client

## Dependencies (3)

- [semver](https://npm.io/package/semver.md) ^7.5.2
- [@simple-libs/stream-utils](https://npm.io/package/@simple-libs/stream-utils.md) ^2.0.0
- [@simple-libs/child-process-utils](https://npm.io/package/@simple-libs/child-process-utils.md) ^2.0.0

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 3.1.2 (latest) — 2026-08-10
- 3.1.1 — 2026-08-07
- 3.1.0 — 2026-07-06
- 3.0.2 — 2026-07-04
- 3.0.1 — 2026-06-27
- 3.0.0 — 2026-06-26
- 2.7.0 — 2026-04-07
- 2.6.0 — 2026-03-01
- 2.5.1 — 2025-06-02
- 2.5.0 — 2025-06-02
- 2.4.0 — 2025-05-27
- 2.3.0 — 2025-05-23
- 2.2.0 — 2025-05-19
- 2.1.0 — 2025-05-19
- 2.0.0 — 2025-02-16
- … 2 more at https://npm.io/package/@conventional-changelog/git-client/versions

## README

# @conventional-changelog/git-client

[![ESM-only package][package]][package-url]
[![NPM version][npm]][npm-url]
[![Node version][node]][node-url]
[![Dependencies status][deps]][deps-url]
[![Install size][size]][size-url]
[![Build status][build]][build-url]
[![Coverage status][coverage]][coverage-url]

[package]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
[package-url]: https://nodejs.org/api/esm.html

[npm]: https://img.shields.io/npm/v/@conventional-changelog/git-client.svg
[npm-url]: https://npmjs.com/package/@conventional-changelog/git-client

[node]: https://img.shields.io/node/v/@conventional-changelog/git-client.svg
[node-url]: https://nodejs.org

[deps]: https://img.shields.io/librariesio/release/npm/@conventional-changelog/git-client
[deps-url]: https://libraries.io/npm/@conventional-changelog%2Fgit-client

[size]: https://packagephobia.com/badge?p=@conventional-changelog/git-client
[size-url]: https://packagephobia.com/result?p=@conventional-changelog/git-client

[build]: https://img.shields.io/github/actions/workflow/status/conventional-changelog/conventional-changelog/tests.yaml?branch=master
[build-url]: https://github.com/conventional-changelog/conventional-changelog/actions

[coverage]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/conventional-changelog/conventional-changelog?branch=master

Simple git client for conventional changelog packages.

## Install

```bash
# pnpm
pnpm add @conventional-changelog/git-client conventional-commits-filter conventional-commits-parser
# yarn
yarn add @conventional-changelog/git-client conventional-commits-filter conventional-commits-parser
# npm
npm i @conventional-changelog/git-client conventional-commits-filter conventional-commits-parser
```

Note: `conventional-commits-filter` and `conventional-commits-parser` are required only if you need `ConventionalGitClient#getCommits` method.

## Usage

```js
import {
  GitClient,
  ConventionalGitClient
} from '@conventional-changelog/git-client'

// Basic git client
const client = new GitClient(process.cwd())

await client.add('package.json')
await client.commit({ message: 'chore: release v1.0.0' })
await client.tag({ name: 'v1.0.0' })
await client.push('master')

// Conventional git client, which extends basic git client
const conventionalClient = new ConventionalGitClient(process.cwd())

console.log(await conventionalClient.getVersionFromTags()) // v1.0.0
```

## Documentation

For the API reference, visit the [documentation website](https://conventional-changelog.js.org/git-client/).

## License

MIT © [Dan Onoshko](https://github.com/dangreen)

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