streak-tracker-cli
v1.0.0
Published
Generate a streak tracker XLSX and PDF from a bundled Excel template.
Readme
Streak Tracker CLI
Generate a calendar-correct streak tracker .xlsx and .pdf from the bundled Streak Tracker.xlsx template.
Requirements
- Node.js 18+
- LibreOffice available in
PATH
Install
Local development:
npm installRun directly:
node ./bin/streak-tracker.js --helpInstall as a global CLI from npm later:
npm install -g streak-tracker-cli
streak-tracker --helpOr run without installing globally:
npx streak-tracker-cli --helpUsage
Generate a full month:
streak-tracker --month 2025-06Generate a 30-day streak starting from today:
streak-tracker --currentGenerate a custom streak from a start date:
streak-tracker --start-date 2025-01-30 --days 30Optional flags:
streak-tracker \
--month 2025-06 \
--output-dir ./files \
--name june-streakOutput
By default, files are written to ./output relative to the directory where the command is run.
Examples:
- running from
~/Desktopsaves to~/Desktop/output --output-dir ./filessaves to./files
The CLI prints the final paths for:
<name>.xlsx<name>.pdf
Publish to npm
- Pick the final package name in
package.json - Log in with
npm login - Publish:
npm publishAfter publishing, users can install it with:
npm install -g streak-tracker-cli