tickr-cli
v1.0.1
Published
A CLI-first time-tracking tool
Maintainers
Readme
Tickr
Time that adds up.
Tickr is a CLI-first time-tracking tool designed for freelancers, consultants, and engineers who need accurate, auditable work logs without relying on bloated GUIs. It bridges the gap between your effort and client trust with verifiable time reports.
Tech Stack
Features
- ⏱️ Precise Time Tracking: Start and stop work sessions per project.
- 🤝 Build Trust: Produce detailed, transparent logs that give clients confidence in your billed hours.
- 🧱 Immutable Data: Work sessions are stored securely in a local SQLite database (
~/.tickr/tickr.db). - 📊 Interactive Reporting: Generate reports filtered by date and project.
- 🖥️ Terminal Dashboard: Visual dashboard with real-time stats (
tickr dash). - 🍅 Pomodoro Timer: Built-in 25-minute focus timer (
tickr pomo). - 🧾 PDF Invoicing: Generate professional PDF invoices and summaries.
- 🧠 Smart Logic: Automatically handles overlapping sessions and ensures data integrity.
Installation
npm install -g tickr-cliCore Commands
Start & Stop
Start tracking time for a project. If another session is active, it stops automatically.
tickr start <project> # Start tracking
tickr stop # Stop tracking
tickr status # Check current sessionDashboard
Launch the interactive terminal dashboard to view history and stats.
tickr dashProductivity
Pomodoro Timer
Start a 25-minute focus session.
tickr pomo <project>Reporting & Invoices
CLI Report
Generate a text-based summary of time spent.
tickr report [project] # specific project
tickr report --since 2024-01-01 # custom date rangePDF Summary
Generate a detailed PDF project summary.
tickr summary <project>PDF Invoice
Generate a billable PDF invoice.
tickr invoice <project> --rate 100 # $100/hr rateEmail Integration
1. Setup SMTP
Configure your email provider to enable sending reports.
tickr config --host smtp.gmail.com --port 587 --user [email protected] --pass "app-password"Tip: Use App Passwords for Gmail/Outlook.
2. Configure Project
Link emails to a project for auto-sending.
tickr project <name> --user-email [email protected] --client-email [email protected]3. Send
Reports, Summaries, and Invoices will automatically be emailed if configured.
tickr report <project> # Emails text report
tickr summary <project> # Emails PDF summary
tickr invoice <project> # Emails invoice PDFData Storage
Data is stored in ~/.tickr/tickr.db.
You can back up this file to save your history.
Development
Run tests:
node test/suite.js