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 for installation instructions.
Feedback
Feel free to leave me feedback at fewmints@gmail.com. To report issues, do so at Github.
Usage
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]Commands
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
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
punch log
View the historical sessions.
USAGE
$ punch log
ALIASES
$ punch l
See code: src\commands\log.ts
punch out
End the current session.
USAGE
$ punch out
ALIASES
$ punch o
See code: 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
- 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