# auto-weekly

> auto generate weekly by git commit log.

Latest version **1.0.5** (published 2021-02-24) · ISC license · 0 weekly downloads

## Install

```sh
npm install auto-weekly
pnpm add auto-weekly
yarn add auto-weekly
bun add auto-weekly
```

Provides the command `auto-weekly`.

## 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 | 1.0.5 |
| Published | 2021-02-24 |
| First published | 2021-02-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 24.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | caoxm |
| Maintainers | cxm123 |

## Links

- npm: https://www.npmjs.com/package/auto-weekly
- Repository: https://github.com/caoxmm/gitlog-weekly
- Homepage: https://github.com/caoxmm/gitlog-weekly#readme
- Issues: https://github.com/caoxmm/gitlog-weekly/issues
- npm.io page: https://npm.io/package/auto-weekly

## Dependencies (6)

- [chalk](https://npm.io/package/chalk.md) ^4.1.0
- [mkdirp](https://npm.io/package/mkdirp.md) ^1.0.4
- [exceljs](https://npm.io/package/exceljs.md) ^4.2.0
- [enquirer](https://npm.io/package/enquirer.md) ^2.3.6
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.1.0
- [commander](https://npm.io/package/commander.md) ^7.1.0

## Recent versions

- 1.0.5 (latest) — 2021-02-24
- 1.0.4 — 2021-02-23
- 1.0.3 — 2021-02-23
- 1.0.2 — 2021-02-23
- 1.0.1 — 2021-02-23

## README

### auto generate weekly xlsx by git logs

1.usage

```
npx auto-weekly [options]

Options:
  -V, --version                output the version number
  -u, --users [users...]       filter by usernames
  -p, --path <path>            git repository in local system path
  -d, --dist <dist>            the directory output weekly excel
  -ucn, --username <userName>  reporter user name chinese version
  -from, --from <startDate>    filter commits after start date, yyyy-mm-dd (default: "current week start date")
  -to, --to <endDate>          filter commits before end date, yyyy-mm-dd (default: "current week end date")
  -h, --help                   display help for command
```

2.example

run under command at a git project base path.

```
npx auto-weekly
```

or just

```
npx auto-weekly -u zhangsan zhangs -ucn 张三 -p . -d ./weekly
```

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