auto-clock-cli
v1.0.5
Published
CLI tool for automatic clock in/out with HRMS integration
Maintainers
Readme
Auto Clock CLI
A CLI tool to automatically clock in and clock out at scheduled times.
Installation
npm install -g auto-clock-cliQuick Start
1. Setup (first-time users)
auto-clock setupThis will prompt you for:
- Password
- Location (default: TechBodia)
- Clock in time (e.g., 08:00)
- Clock out time (e.g., 17:00)
2. Test manually
auto-clock in # Clock in now
auto-clock out # Clock out now3. Enable automatic scheduling
auto-clock enable # Enable smart auto clockCommands
| Command | Description |
|---------|-------------|
| auto-clock setup | Interactive setup wizard |
| auto-clock in | Clock in now |
| auto-clock out | Clock out now |
| auto-clock smart | Smart clock (auto detects if in/out needed) |
| auto-clock history [days] | Show clock history (default: 14 days) |
| auto-clock reclock | Request reclock for a single day |
| auto-clock reclock-range | Request reclock for multiple days |
| auto-clock enable | Enable smart auto clock |
| auto-clock disable | Disable auto clock |
| auto-clock schedule | Change clock in/out times |
| auto-clock status | Show current configuration |
| auto-clock logs | Show recent logs |
| auto-clock token | Manually set JWT token |
| auto-clock help | Show help |
Configuration
Config is stored at: ~/.auto-clock/config.json
Logs are stored at: ~/.auto-clock/clock.log
Smart Auto Clock
The enable command sets up smart auto clock that:
- Checks every 10 minutes during work hours
- Auto clocks IN if: after your clock-in time and not yet clocked in
- Auto clocks OUT if: after your clock-out time and not yet clocked out
- Only runs Monday-Friday
Benefit: Even if you open your laptop late, it will still clock you in!
Reclock
If you forgot to clock in/out, use reclock:
auto-clock reclock # Single day
auto-clock reclock-range # Multiple days (date range)For Multiple Users
Each user:
- Installs:
npm install -g auto-clock-cli - Runs setup:
auto-clock setup - Enables:
auto-clock enable
Each user's config is stored separately in their home directory.
Uninstall
npm uninstall -g auto-clock-cli
rm -rf ~/.auto-clock