# gitlog > Git log parser for Node.JS Latest version **5.1.0** (published 2024-08-05) · BSD-3-Clause license · 0 weekly downloads ## Install ```sh npm install gitlog pnpm add gitlog yarn add gitlog bun add gitlog ``` ## Health **Score 30/100 (F)** — status: abandoned. Positive: has types; esm support; no vulnerabilities; high quality score. Warnings: low downloads. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 5.1.0 | | Published | 2024-08-05 | | First published | 2012-06-26 | | Weekly downloads | 0 | | License | BSD-3-Clause | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Node | >= 20.x | | Dependencies | 1 | | Unpacked size | 37.1 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 136 | | Author | Dom Harrington | | Maintainers | domharrington, alisowski | | Keywords | git, log, parser | ## Links - npm: https://www.npmjs.com/package/gitlog - Repository: https://github.com/domharrington/node-gitlog - Homepage: https://github.com/domharrington/node-gitlog#readme - Issues: https://github.com/domharrington/node-gitlog/issues - npm.io page: https://npm.io/package/gitlog ## Dependencies (1) - [debug](https://npm.io/package/debug.md) ^4.1.1 ## Alternatives - [cli-color](https://npm.io/package/cli-color.md) — 3.4M weekly downloads - [log](https://npm.io/package/log.md) — 1.3M weekly downloads - [logstash-client](https://npm.io/package/logstash-client.md) — 4.5K weekly downloads - [@nocobase/plugin-logger](https://npm.io/package/@nocobase/plugin-logger.md) — 2.0K weekly downloads - [child-process-debug](https://npm.io/package/child-process-debug.md) — 695 weekly downloads ## Recent versions - 5.1.0 (latest) — 2024-08-05 - 3.2.1-canary.4ad2eb5.0 (canary) — 2020-04-07 - 5.0.2 — 2024-07-16 - 5.0.1 — 2024-06-17 - 5.0.0 — 2024-06-17 - 4.0.8 — 2023-05-16 - 4.0.4 — 2021-01-05 - 4.0.3 — 2020-10-05 - 4.0.2 — 2020-10-02 - 4.0.1 — 2020-10-01 - 4.0.0 — 2020-04-13 - 3.3.6 — 2020-04-09 - 3.3.5 — 2020-04-08 - 3.3.4 — 2020-04-07 - 3.3.3 — 2020-04-07 - … 20 more at https://npm.io/package/gitlog/versions ## README # node-gitlog Git log parser for Node.JS ## Installation ```sh npm install gitlog --save ``` ## Usage ```js import gitlog from "gitlog"; const options = { repo: __dirname + "/test-repo-folder", number: 20, author: "Dom Harrington", fields: ["hash", "abbrevHash", "subject", "authorName", "authorDateRel"], execOptions: { maxBuffer: 1000 * 1024 }, }; const commits = await gitlog(options); ``` `gitlog` comes with full typescript support! ```ts import gitlog, { GitlogOptions } from "gitlog"; // Option 1: Just use the function, returned commit type has specified fields gitlog({ repo: "foo", fields: ["subject", "authorName", "authorDate"], }); // Option 2: Use Options type to create options const options: GitlogOptions<"subject" | "authorName" | "authorDate"> = { repo: "foo", fields: ["subject", "authorName", "authorDate"], }; gitlog(options); // Option 3: Typescript Magic const options = { repo: "foo", fields: ["subject", "authorName", "authorDate"] as const, }; gitlog(options); // NOT SUPPORTED: Without "as const" gitlog can't create a good return type const options = { repo: "foo", fields: ["subject", "authorName", "authorDate"], }; gitlog(options); ``` ## Options See [git log](http://git-scm.com/docs/git-log) ### repo The location of the repo, required field. ### number The number of commits to return, defaults to 10. ### since/after Show commits more recent than a specific date. ### until/before Show commits older than a specific date. ### author/committer Limit the commits output to ones with author/committer header lines that match the specified pattern. ### nameStatus Below fields was returned from the log: - files - changed files names (array) - status - changed files status (array) This option is enabled by default. ### findCopiesHarder Much more likely to set status codes to 'C' if files are exact copies of each other. This option is disabled by default. ### includeMergeCommitFiles Pass the `-m` option to includes files in a merge commit. This option is disabled by default. ### follow Pass the --follow option to follow files across renames. This option is disabled by default. ### all Find commits on all branches instead of just on the current one. This option is disabled by default. ### branch ([revision range](https://git-scm.com/docs/git-log#git-log-ltrevisionrangegt)) Show only commits in the specified branch or revision range. By default uses the current branch and defaults to `HEAD` (i.e. the whole history leading to the current commit). ### fileLineRange Optional field for getting only the commits that affected a specific line range of a given file. ### file Optional file filter for the `git log` command ### execOptions Type: `Object` Specify some options to be passed to the [.exec()](http://nodejs.org/api/child_process.html#child_process_child_process_exec_command_options_callback) method: - `cwd` String _Current working directory of the child process_ - `env` Object _Environment key-value pairs_ - `setsid` Boolean - `encoding` String _(Default: 'utf8')_ - `timeout` Number _(Default: 0)_ - `maxBuffer` Number _(Default: 200\*1024)_ - `killSignal` String _(Default: 'SIGTERM')_ ### optional fields An array of fields to return from the log, here are the possible options: - `hash` - the long hash of the commit e.g. 7dd0b07625203f69cd55d779d873f1adcffaa84a - `abbrevHash` - the abbreviated commit hash e.g. 7dd0b07 - `treeHash` - the tree hash of the commit - `abbrevTreeHash` - the abbreviated commit hash - `parentHashes` - the parent hashes - `abbrevParentHashes` - the abbreviated parent hashes - `authorName` - author name of the commit - `authorEmail` - author email of the commit - `authorDate` - author date of the commit - `authorDateRel` - relative author date of the commit - `committerName` - committer name - `committerEmail` - committer email - `committerDate` - committer date - `committerDateRel` - relative committer date - `subject` - commit message (first line) - `body` - commit body - `rawBody` - raw body (subject + body) - `tag` - raw tag information of commit Defaults to 'abbrevHash', 'hash', 'subject' and 'authorName'. ## How it works This module works by executing a child process (using `child_process.exec()`) to the `git` executable, then parsing the stdout into commits. This is done using the `--pretty` command line option which allows you to provide a custom formatter to `git log`. To enable easy parsing the format is delimited by a tab (`\t`) character. ## Example The following is an example of what a parsed commit might look like. ```json { "hash": "6a7ef5e3b3d9c77743140443c8f9e792b0715721", "abbrevHash": "6a7ef5e", "treeHash": "f1bf51b15b48a00c33727f364afef695029864c0", "abbrevTreeHash": "f1bf51b", "parentHashes": "cfe06dbdb8d0a193640977e016a04678f8f3b04f", "abbrevParentHashes": "cfe06dbdb8d0a193640977e016a04678f8f3b04f", "authorName": "Dom Harrington", "authorEmail": "dom@harringtonxxxxx", "authorDate": "2015-04-09 09:39:23 +0100", "authorDateRel": "6 days ago", "committerName": "Dom Harrington", "committerEmail": "dom@harringtonxxxxx", "committerDate": "Thu Apr 9 09:39:23 2015 +0100", "committerDateRel": "6 days ago", "subject": "1.0.0", "status": ["M"], "files": ["package.json"] } ``` ## Contributors ✨ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

domharrington
💻 📖 💡 🤔
Andrew Lisowski
💻 📖 🚇 🚧
Stefan Oderbolz
🐛 💻
palortoff
🐛 💻
Malys
🐛 💻 📖
Mike Mellor
💻
Hunter Medney
💻

Peter Baranyi
💻 🐛
Benjamin Blackwood
📖
Ash Summers
💻 ⚠️
007design
💻
tobaccoplaybook
💻
Nicola
💻
bluelovers
💻

Marwan Butrous
💻
FishOrBear
💻
Asjid Kalam
💻
Jamie Slome
💻
huntr-helper
💻
Chris NeJame
📖 ⚠️ 💻
Ron
⚠️ 💻

Juan Ignacio Garzón
📖 💻
Vitali Lovich
⚠️ 💻
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! --- _Source: https://npm.io/package/gitlog · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._