# guet

> > enable contribution tracking when pair programming with guet

Latest version **4.0.2** (published 2022-08-25) · MIT license · 0 weekly downloads

## Install

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

Provides the command `guet`.

## 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 | 4.0.2 |
| Published | 2022-08-25 |
| First published | 2022-08-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 59.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 12 |
| Author | Christopher M. Boyer |
| Maintainers | chiptopher |

## Links

- npm: https://www.npmjs.com/package/guet
- Repository: https://github.com/chiptopher/guet
- Homepage: https://github.com/chiptopher/guet#readme
- Issues: https://github.com/chiptopher/guet/issues
- npm.io page: https://npm.io/package/guet

## Dependencies (3)

- [luxon](https://npm.io/package/luxon.md) ^3.0.1
- [colors](https://npm.io/package/colors.md) ^1.4.0
- [dotenv](https://npm.io/package/dotenv.md) ^16.0.1

## Recent versions

- 4.0.2 (latest) — 2022-08-25
- 4.0.1 — 2022-08-20

## README

# guet

> enable contribution tracking when pair programming with guet

Pair programming is integral part of many software development lifecycles. When pairing, you may want to track each committer's contributions. Using **guet** enables that functionality without changing the normal git workflow.


## Install

To include it in your project:
```
npm install guet -D
```

To install globally:
```
npm install -g guet
```

## Usage
Below are the available commands. For more detailed usage documentation, run `guet <command> --help`.

| Command | Description |
| ------------ | ---------------------------------|
| init  | start using guet in the current repository |
| add | add committers for use in pairing |
| set | set the current committers in the current repository
| get | get information about guet committers |
| remove | remove a committer by its initials |
| yeet | remove guet configurations |
| hook | apply guet modifications to the current git commit |

### In pre-existing hooks.

guet can easily integrate with other hook managing systems. In each of `pre-commit`, `commit-msg`, and `post-commit` within `.git/hooks/` you'll want to add each of the following commands respectively

```
// .git/hooks/pre-commit
npx guet hook pre-commit

// .git/hooks/commit-msg
npx guet hook commit-msg

// .git/hooks/post-commit
npx guet hook post-commit
```

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