{"id":18774220,"url":"https://github.com/leny/tankipas","last_synced_at":"2025-08-19T08:12:35.421Z","repository":{"id":18267841,"uuid":"21428813","full_name":"leny/tankipas","owner":"leny","description":"Compute approximate development time spent on a project, using logs from version control system.","archived":false,"fork":false,"pushed_at":"2019-10-22T18:51:04.000Z","size":25,"stargazers_count":11,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-09T17:16:52.445Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"CoffeeScript","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/leny.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE-MIT","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-07-02T15:11:16.000Z","updated_at":"2025-03-04T10:52:33.000Z","dependencies_parsed_at":"2022-08-27T05:12:44.211Z","dependency_job_id":null,"html_url":"https://github.com/leny/tankipas","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/leny/tankipas","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leny%2Ftankipas","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leny%2Ftankipas/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leny%2Ftankipas/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leny%2Ftankipas/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leny","download_url":"https://codeload.github.com/leny/tankipas/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leny%2Ftankipas/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271121168,"owners_count":24702723,"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","status":"online","status_checked_at":"2025-08-19T02:00:09.176Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2024-11-07T19:37:45.909Z","updated_at":"2025-08-19T08:12:35.401Z","avatar_url":"https://github.com/leny.png","language":"CoffeeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tankipas\n\n[![NPM version](http://img.shields.io/npm/v/tankipas.svg)](https://www.npmjs.org/package/tankipas) ![Dependency Status](https://david-dm.org/leny/tankipas.svg) ![Downloads counter](http://img.shields.io/npm/dm/tankipas.svg) [![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)\n\n\u003e Compute approximate development time spent on a project, using logs from version control system.\n\n* * *\n\n## How it works ?\n\n**tankipas**, according to the options used, read the logs of the current working directory's version control system and computes the difference between each commit timestamp.   \nAs the resulting time **can't** reflect the reality, **tankipas** use a `gap` option, a number of minutes above wich the time between two commits is ignored.\n\n## Usage as node.js module\n\n### Installation\n\nTo use **tankipas** as a node.js module, install it first to your project.\n\n    npm install --save tankipas\n    \n### Usage\n\nUsing **tankipas** is simple, after require it : \n\n    tankipas = require( \"tankipas\" );\n    \n    tankipas( \".\", {}, function( oError, iTotal ) {\n        // do awesome things here.\n    } );\n    \n### Signature\n\n    tankipas( sRepositoryPath [, oOptions [, fCallback ] ] )\n    \n#### Arguments\n\n- `sRepoPath` is the path to the repository to analyse.\n- `oOptions` is an object which can contain the following properties :\n    - `system`: force the version system to analyse (by default, try to guess)\n    - `gap`: number of minutes above wich the time between two commits is ignored in the total (default to `120`)\n    - `user`: use only the commits of the given user\n    - `commit`: compute the result since the given commit\n    - `branch`: use only the commits of the given branch\n- `fCallback` is the callback function, which returns two arguments : \n    - `oError`: if an error occurs during the process\n    - `iTotal`: the total of time spent on the project, in seconds\n    \n## Usage as *command-line tool*\n\n### Installation\n\nTo use **tankipas** as a command-line tool, it is preferable to install it globally.\n\n    (sudo) npm install -g tankipas\n\n### Usage\n\nUsing **tankipas** is simple, from inside a `git` or `mercurial` repo: \n\n    tankipas [options]\n    \n    Options:\n\n        -h, --help             output usage information\n        -V, --version          output the version number\n        -s, --system \u003csystem\u003e  force the version system to analyse (by default, try to guess)\n        -g, --gap \u003camount\u003e     number of minutes above wich the time between two commits is ignored in the total.\n        -u, --user \u003cuser\u003e      use only the commits of the given user.\n        -c, --commit \u003ccommit\u003e  compute the result since the given commit.\n        -b, --branch \u003cbranch\u003e  use only the commits of the given branch.\n        -r, --raw              show raw result, as number of seconds spent on the project.\n    \n#### Options\n\n##### system (`-s`,`--system \u003csystem\u003e`)\n\nForce the version control system to use for the current directory's analysis.  \nBy default, **tankipas** will try to guess the current version control system.\n\nFor now, **tankipas** supports `git` and `mercurial` systems.\n\n##### gap (`-g`,`--gap \u003camount\u003e`)\n\n**tankipas** compute his result by sum all the time between commits. As you can't pretend working 24h/day (*I tried, it's hard, after 3 days*), **tankipas** ignore the time between commits separed by more than the given `gap` option. By default, the gap is `120` (minutes).\n\n##### user (`-u`,`--user \u003cuser\u003e`)\n\nIf you work as a team, you can be interested to filters the commits and compute the time of only one user, which you can precise with the `user` option.\n\n##### commit (`-c`,`--commit \u003ccommit\u003e`)\n\nThe result will be computed since the given commit reference, instead of the beginning of the project.\n\n##### branch (`-b`,`--branch \u003cbranch\u003e`)\n\nYou can filters the commits and compute the time of only one branch, which you can precise with the `branch` option.\n\n##### raw (`-r`,`--raw`)\n\nBy default, **tankipas** outputs his result in a *human-readable* format. If you want to use the result with another tool, the `raw` option will output results as an amount of `seconds`.\n\n##### help (`-h`,`--help`)\n\nOutput usage information.\n\n##### version (`-v`,`--version`)\n\nOutput **tankipas**' version number.\n\n## Usage as grunt plugin\n\nPlease refer to the [grunt-tankipas](https://github.com/leny/grunt-tankipas) documentation.\n    \n## Contributing\n\nIn lieu of a formal styleguide, take care to maintain the existing coding style. Lint your code using [Grunt](http://gruntjs.com/).\n\n## Release History\n\n* **0.4.1**: Update dependencies (*08/10/14*)\n* **0.4.0**: Add `branch` option (*13/07/14*)\n* **0.3.0**: Add `commit` option (*11/07/14*)\n* **0.2.0**: Node module version, raw returns seconds instead of minutes (*03/07/14*)\n* **0.1.1**: Fix *rounding* issue for minutes (*02/07/14*)\n* **0.1.0**: Initial release (*02/07/14*)\n\n### TODO\n    \n- [x] add progress indicator\n- [x] node module version\n- [x] deprecate `grunt-elapsed` module and create `grunt-tankipas`\n- [x] add 'since commit' option\n- [x] add branch support\n- [ ] add multiple users support\n- [ ] add support for **svn**\n- [ ] allow to give one or multiple paths\n\n## License\nCopyright (c) 2014 Leny  \nLicensed under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleny%2Ftankipas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleny%2Ftankipas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleny%2Ftankipas/lists"}