# taggit

> Create a tag on remote git with version number in package.json (or bower.json)

Latest version **2.0.3** (published 2019-02-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install taggit
pnpm add taggit
yarn add taggit
bun add taggit
```

Provides the command `taggit`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.3 |
| Published | 2019-02-24 |
| First published | 2015-07-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 3 |
| Unpacked size | 14.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | github, git, tag, automation |

## Links

- npm: https://www.npmjs.com/package/taggit
- Repository: https://github.com/okunishinishi/node-taggit
- Homepage: https://github.com/okunishinishi/node-taggit#readme
- Issues: https://github.com/okunishinishi/node-taggit/issues
- npm.io page: https://npm.io/package/taggit

## Dependencies (3)

- [argx](https://npm.io/package/argx.md) ^4.0.0
- [execcli](https://npm.io/package/execcli.md) ^5.0.4
- [commander](https://npm.io/package/commander.md) ^2.9.0

## Alternatives

- [@lexical/table](https://npm.io/package/@lexical/table.md) — 3.0M weekly downloads
- [mantine-datatable](https://npm.io/package/mantine-datatable.md) — 98.2K weekly downloads
- [react-native-collapsible-tab-view](https://npm.io/package/react-native-collapsible-tab-view.md) — 70.6K weekly downloads
- [@handsontable/vue3](https://npm.io/package/@handsontable/vue3.md) — 16.1K weekly downloads
- [vuewordcloud](https://npm.io/package/vuewordcloud.md) — 7.2K weekly downloads

## Recent versions

- 2.0.3 (latest) — 2019-02-24
- 2.0.2 — 2016-07-30
- 2.0.1 — 2016-06-30
- 2.0.0 — 2016-05-11
- 1.4.0 — 2016-02-21
- 1.3.1 — 2015-09-21
- 1.3.0 — 2015-09-13
- 1.2.1 — 2015-09-12
- 1.2.0 — 2015-09-12
- 1.1.1 — 2015-08-29
- 1.1.0 — 2015-08-08
- 1.0.4 — 2015-07-23
- 1.0.3 — 2015-07-12
- 1.0.2 — 2015-07-12
- 1.0.1 — 2015-07-12
- … 1 more at https://npm.io/package/taggit/versions

## README

taggit
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]

[bd_repo_url]: https://github.com/okunishinishi/node-taggit
[bd_travis_url]: http://travis-ci.org/okunishinishi/node-taggit
[bd_travis_shield_url]: http://img.shields.io/travis/okunishinishi/node-taggit.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/okunishinishi/node-taggit
[bd_travis_com_shield_url]: https://api.travis-ci.com/okunishinishi/node-taggit.svg?token=
[bd_license_url]: https://github.com/okunishinishi/node-taggit/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/okunishinishi/node-taggit
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/okunishinishi/node-taggit.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/okunishinishi/node-taggit.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/okunishinishi/node-taggit
[bd_gemnasium_shield_url]: https://gemnasium.com/okunishinishi/node-taggit.svg
[bd_npm_url]: http://www.npmjs.org/package/taggit
[bd_npm_shield_url]: http://img.shields.io/npm/v/taggit.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Create a tag on remote git with version number in package.json (or bower.json)

<!-- Description End -->




<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/readme/01.Installation.md.hbs" Start -->

<a name="section-doc-readme-01-installation-md"></a>

Installation
-----

```bash
npm install taggit --save-dev
```


<!-- Section from "doc/readme/01.Installation.md.hbs" End -->

<!-- Section from "doc/readme/02.Usage.md.hbs" Start -->

<a name="section-doc-readme-02-usage-md"></a>

Usage
---------

Call `taggit()` at project root path where `package.json` exists.

```javascript
'use strict'

let basedir = __dirname;
process.chdir(basedir) //Move to project root.

const taggit = require('taggit')

// Create remote git tag named with package.json version. (eg. v1.0.0)
taggit({
    // Options
}, (err) => {
    /*...*/
})

```


<!-- Section from "doc/readme/02.Usage.md.hbs" End -->

<!-- Section from "doc/readme/03.Options.md.hbs" Start -->

<a name="section-doc-readme-03-options-md"></a>

Options
---------

| Key | Default | Description |
| --- | --- | --- |
| tag |  | Name of tag. By default, name is resolved form package.json. |
| cwd |  | Working directory path. |


<!-- Section from "doc/readme/03.Options.md.hbs" End -->

<!-- Section from "doc/readme/04.CLI.md.hbs" Start -->

<a name="section-doc-readme-04-c-l-i-md"></a>

Using with CLI
---------

Install as a global module.

```bash
$ npm install taggit -g
```

Then,

```bash
$ taggit -t "v0.0.5"
```

<!-- Section from "doc/readme/04.CLI.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/okunishinishi/node-taggit/blob/master/LICENSE).

<!-- LICENSE End -->

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