# standup-helper

> Pulls various information from github to help a developer in creating a standup update.

Latest version **0.2.0** (published 2018-10-20) · MIT license · 0 weekly downloads

## Install

```sh
npm install standup-helper
pnpm add standup-helper
yarn add standup-helper
bun add standup-helper
```

Provides the command `standup-helper`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2018-10-20 |
| First published | 2018-08-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 2.9 MB |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Steven Gassert |
| Maintainers | steven.gassert |

## Links

- npm: https://www.npmjs.com/package/standup-helper
- Repository: https://github.com/stevengassert94/standup-helper
- Homepage: https://github.com/stevengassert94/standup-helper#readme
- Issues: https://github.com/stevengassert94/standup-helper/issues
- npm.io page: https://npm.io/package/standup-helper

## Dependencies (9)

- [joi](https://npm.io/package/joi.md) ^13.6.0
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [inquirer](https://npm.io/package/inquirer.md) ^6.2.0
- [commander](https://npm.io/package/commander.md) ^2.17.1
- [timestring](https://npm.io/package/timestring.md) ^5.0.1
- [configstore](https://npm.io/package/configstore.md) ^4.0.0
- [@octokit/rest](https://npm.io/package/@octokit/rest.md) ^15.10.0
- [update-notifier](https://npm.io/package/update-notifier.md) ^2.5.0
- [semantic-release](https://npm.io/package/semantic-release.md) ^13.1.1

## Recent versions

- 0.2.0 (latest) — 2018-10-20
- 0.1.2 — 2018-09-19
- 0.1.1 — 2018-08-30
- 0.1.0 — 2018-08-29
- 0.0.2 — 2018-08-29
- 0.0.1 — 2018-08-29

## README

<h1 align="center" style="border-bottom: none;">🚀 Standup Helper</h1>
<h3 align="center">Collects and organizes your recent github activities for the purpose of forming a stand-up update.
</h3>
<p align="center">
  <a href="http://travis-ci.org/stevengassert94/standup-helper">
    <img alt="Travis" src="https://travis-ci.org/stevengassert94/standup-helper.svg?branch=master">
  </a>
  <a href="#badge">
    <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
  </a>
</p>
</p>

![preview](https://raw.githubusercontent.com/stevengassert94/standup-helper/master/images/standup-app-trimmed.gif)


## Getting Started

You will need to have [Node.js](https://nodejs.org/en/download/) installed.

```bash
$ npm i -g standup-helper
```
init standup-helper
```bash
$ standup-helper --init
```
Print the standup message

```bash
$ standup-helper
```

Example output

```
<Add example output here>
```

## Help

```bash
$ standup-helper --help            # or -h (see all possibles options)
  Usage: cli [options]

  Options:

    -v, --version                      output the version number
    --init                             Initialize standup-helper
    -i, --issues                       Include issues
    -p, --pull-requests                Include pull requests
    -c, --commits                      Include commits
    -g, --github-url [url]             The GitHub URL (default: https://api.github.com)
    -a, --access-token [access_token]  The GitHub access token
    -h, --help                         output usage information

```

## Roadmap
 * Adding ZenHub integration (?)

## LICENSE
MIT.

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