# punch-cli

> Time Tracking CLI tool.

Latest version **1.0.4** (published 2020-05-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install punch-cli
pnpm add punch-cli
yarn add punch-cli
bun add punch-cli
```

Provides the command `punch`.

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2020-05-29 |
| First published | 2020-05-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 8 |
| Unpacked size | 31.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Rishi Gautam |
| Maintainers | rockbender |
| Keywords | oclif, punch-cli, punch, time tracker, cli tool, git |

## Links

- npm: https://www.npmjs.com/package/punch-cli
- Repository: https://github.com/rockbender/punch-cli
- Issues: https://github.com/rockbender/punch-cli/issues
- npm.io page: https://npm.io/package/punch-cli

## Dependencies (8)

- [chalk](https://npm.io/package/chalk.md) ^4.0.0
- [tslib](https://npm.io/package/tslib.md) ^1.11.1
- [log4js](https://npm.io/package/log4js.md) ^6.2.1
- [moment](https://npm.io/package/moment.md) ^2.24.0
- [@oclif/config](https://npm.io/package/@oclif/config.md) ^1.14.0
- [@oclif/command](https://npm.io/package/@oclif/command.md) ^1.5.19
- [better-sqlite3](https://npm.io/package/better-sqlite3.md) ^6.0.1
- [@oclif/plugin-help](https://npm.io/package/@oclif/plugin-help.md) ^2.2.3

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2020-05-29
- 1.0.3 — 2020-05-26
- 1.0.2 — 2020-05-24
- 1.0.1 — 2020-05-24
- 1.0.0 — 2020-05-24

## README

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/punch-cli.svg)](https://npmjs.org/package/punch-cli)
[![Downloads/week](https://img.shields.io/npm/dw/punch-cli.svg)](https://npmjs.org/package/punch-cli)
[![License](https://img.shields.io/npm/l/punch-cli.svg)](https://github.com/rockbender/punch-cli/blob/master/LICENSE)

About this project
=========

A simple CLI tool to track your work session.

# Features

* Track a work session by punching in/out
* Add notes to a shift
* View past shitfs in a tablular format

# Dependency
The application requires npm-gyp to be available. For Windows users, please follow this guide [here](https://www.npmjs.com/package/node-gyp) for installation instructions.

# Feedback
Feel free to leave me feedback at _fewmints@gmail.com_. To report issues, do so at [Github](https://github.com/rockbender/punch-cli/issues).

# Usage
```sh-session
Installing
$ npm install punch-cli -g

Start a new session
$ punch in

End a session
$ punch out

View the current/last session
$ punch status

For available switches and aliases
$ punch --help [COMMAND]
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`punch help [COMMAND]`](#punch-help-command)
* [`punch in`](#punch-in)
* [`punch log`](#punch-log)
* [`punch out`](#punch-out)
* [`punch status`](#punch-status)

## `punch help [COMMAND]`

display help for punch

```
USAGE
  $ punch help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI
```

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src\commands\help.ts)_

## `punch in`

Start a new work session. Use -f to restart current session.

```
USAGE
  $ punch in

OPTIONS
  -f, --force
  -m, --message=message

ALIASES
  $ punch i
```

_See code: [src\commands\in.ts](https://github.com/rockbender/punch-cli/blob/v1.0.4/src\commands\in.ts)_

## `punch log`

View the historical sessions.

```
USAGE
  $ punch log

ALIASES
  $ punch l
```

_See code: [src\commands\log.ts](https://github.com/rockbender/punch-cli/blob/v1.0.4/src\commands\log.ts)_

## `punch out`

End the current session.

```
USAGE
  $ punch out

ALIASES
  $ punch o
```

_See code: [src\commands\out.ts](https://github.com/rockbender/punch-cli/blob/v1.0.4/src\commands\out.ts)_

## `punch status`

Shows the currently running session. If an active session is not found then the last session summary is shown.

```
USAGE
  $ punch status

ALIASES
  $ punch s
```

_See code: [src\commands\status.ts](https://github.com/rockbender/punch-cli/blob/v1.0.4/src\commands\status.ts)_
<!-- commandsstop -->
- punch In -- Start a new session. -f to restart current session
- punch out -- End current session
- punch log -- View historical sessions
- punch status -- View the current session or the last session

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