{"id":49569732,"url":"https://github.com/pfei/tomate-cli","last_synced_at":"2026-05-03T13:09:37.428Z","repository":{"id":354619028,"uuid":"954613005","full_name":"pfei/tomate-cli","owner":"pfei","description":null,"archived":false,"fork":false,"pushed_at":"2026-04-29T09:22:37.000Z","size":281,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-29T11:13:53.533Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pfei.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-03-25T10:55:32.000Z","updated_at":"2026-04-29T09:22:41.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/pfei/tomate-cli","commit_stats":null,"previous_names":["pfei/tomate-cli"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/pfei/tomate-cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfei%2Ftomate-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfei%2Ftomate-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfei%2Ftomate-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfei%2Ftomate-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pfei","download_url":"https://codeload.github.com/pfei/tomate-cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pfei%2Ftomate-cli/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32569812,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T06:36:36.687Z","status":"ssl_error","status_checked_at":"2026-05-03T06:36:09.306Z","response_time":103,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-05-03T13:09:36.838Z","updated_at":"2026-05-03T13:09:37.420Z","avatar_url":"https://github.com/pfei.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🍅 tomate-cli\n\nA simple, terminal-based Pomodoro timer and stats tracker.\n\n---\n\n## Table of Contents\n\n- [Features](#features)\n- [Quick Start](#quick-start)\n- [CLI Usage](#cli-usage)\n- [Usage](#usage)\n- [Windows Users](#windows-users)\n- [Development](#development)\n- [Configuration \u0026 Data](#configuration--data)\n- [Custom Config and Metrics Paths](#custom-config-and-metrics-paths)\n- [Dependencies](#dependencies)\n- [License](#license)\n- [Author](#author)\n\n---\n\n## \u003cimg src=\"./docs/screenshot.png\" alt=\"Screenshot of tomate-cli in action\" style=\"width:30%;\"\u003e\n\n---\n\n## Features\n\n- Pomodoro cycles with short/long breaks (configurable durations)\n- Terminal UI with colorful, boxed countdown and controls\n- Sound notifications (assets included)\n- Session statistics: total Pomodoros, average per day/week, break times, and more\n- Task labeling: tag sessions with `--task \u003cname\u003e` to track time per project\n- Time report grouped by task (`--report`, or `--report-json` for JSON output pipeable to `jq`)\n- Config menu: interactive, in-terminal\n- Persistent config and metrics (JSON files in your home directory)\n- Tested core logic (Vitest)\n\n---\n\n## Quick Start\n\n### 1. Requirements\n\n- Node.js v18+\n- Unix-like shell (Linux, macOS, or [WSL2](https://docs.microsoft.com/en-us/windows/wsl/) on Windows)\n- [yad](https://github.com/v1cont/yad) (for popup notifications, optional but recommended)\n\n### 2. Install\n\n```\ngit clone https://github.com/pfei/tomate-cli.git\ncd tomate-cli\nnpm install\n```\n\n### 3. Build\n\n```\nnpm run build\n```\n\n### 4. Run\n\n#### Option 1: Use as a global CLI with `npm link`\n\n```\nnpm link\ntomate\n```\n\n#### Option 2: Run directly with Node\n\n```\nnode ./dist/main.js\n```\n\n---\n\n## CLI Usage\n\n### Show help\n\nWith global CLI:\n\n```\ntomate --help\n```\n\nOr directly:\n\n```\nnode ./dist/main.js --help\n```\n\n### Show stats\n\nWith global CLI:\n\n```\ntomate --stats\n```\n\nOr directly:\n\n```\nnode ./dist/main.js --stats\n```\n\n### Show task report\n\nFormatted output:\n\n```\ntomate --report\n```\n\nJSON output, pipeable to `jq`:\n\n```\ntomate --report-json\n```\n\nCustom metrics file:\n\n```\ntomate --report --metrics-path ~/myconfigs/tomate-metrics.json\ntomate --report-json --metrics-path ~/myconfigs/tomate-metrics.json\n```\n\nPipe to `jq` to sort tasks by time spent:\n\n```\ntomate --report-json | jq 'to_entries | sort_by(-.value.totalDecimalHours) | map({task: .key, sessions: .value.sessions, duration: .value.totalTimeHours})'\n```\n\nExample output:\n\n```json\n[\n  {\n    \"task\": \"myproject\",\n    \"sessions\": 6,\n    \"duration\": \"02:30:00\"\n  },\n  {\n    \"task\": \"emails\",\n    \"sessions\": 2,\n    \"duration\": \"00:50:00\"\n  }\n]\n```\n\n---\n\n### Example: `tomate --help`\n\n```\n  Usage: tomate-cli [options]\n\n  Options:\n    --help              Show this help message and exit\n    --stats             Show productivity stats and exit\n    --report            Show time report grouped by task (formatted)\n    --report-json       Show time report as JSON (pipeable to jq)\n    --reset-config      Reset configuration to defaults\n    --config-path \u003cp\u003e   Use a custom config file path\n    --metrics-path \u003cp\u003e  Use a custom metrics file path\n    --show-paths        Show config and metrics file paths\n    --task \u003cname\u003e       Set a label for the current session\n\n  Key Controls (while running):\n    p     Pause/Resume timer\n    q     Quit\n    c     Open config menu\n```\n\n---\n\n## Usage\n\n### Controls\n\n- `[p]` Pause/Resume timer\n- `[q]` Quit\n- `[c]` Open config menu\n\n### Config Menu\n\n- Change Pomodoro, short break, or long break durations (in seconds)\n- Changes are saved and used for future sessions\n\n### Statistics\n\n- View stats using `tomate --stats` or `node ./dist/main.js --stats`\n- Stats include total Pomodoros, average durations, break stats, and more\n\n### Task labeling\n\nTag your sessions to track time per project:\n\n```\ntomate --task myproject\ntomate --task emails\n```\n\nThen view the breakdown with `tomate --report` or `tomate --report-json`.\n\n---\n\n## Windows Users\n\n\u003e **Note:**  \n\u003e This project uses Unix shell commands (e.g., `rm -rf dist`) in its scripts.  \n\u003e **Windows users must use [WSL2](https://docs.microsoft.com/en-us/windows/wsl/) (Windows Subsystem for Linux) to build and run this project.**\n\u003e Native Windows shells are not supported.\n\n---\n\n## Development\n\n- **Lint:** `npm run lint`\n- **Format:** `npm run format`\n- **Test:** `npm test`\n- **Coverage:** `npm run coverage`\n- **Clean build:** `npm run clean \u0026\u0026 npm run build`\n\n---\n\n## Configuration \u0026 Data\n\n- Config and metrics are stored as JSON files in your home directory (e.g., `~/.config/tomate-cli/`).\n- Sound assets are included and copied to `dist/` on build.\n\n---\n\n## Custom Config and Metrics Paths\n\nBy default, tomate-cli stores config and metrics in your home directory (e.g., `~/.config/tomate-cli/`).  \nYou can override these locations using the `--config-path` and `--metrics-path` options.\n\n**Examples:**\n\n```\n# Use a custom config and metrics file location with the CLI\ntomate --config-path ~/myconfigs/tomate-config.json --metrics-path ~/myconfigs/tomate-metrics.json\n\n# Or, if running directly:\nnode ./dist/main.js --config-path ~/myconfigs/tomate-config.json --metrics-path ~/myconfigs/tomate-metrics.json\n```\n\nThis is useful if you want to:\n\n- Sync your config/metrics with cloud storage\n- Keep multiple profiles\n- Use temporary/test data\n\n---\n\n## Dependencies\n\n- [boxen](https://github.com/sindresorhus/boxen)\n- [chalk](https://github.com/chalk/chalk)\n- [date-fns](https://date-fns.org/)\n- [zod](https://github.com/colinhacks/zod)\n- [Vitest](https://vitest.dev/) (for testing)\n- [yad](https://github.com/v1cont/yad) (for optional popup notifications)\n\n---\n\n## Author\n\nPierre Feilles  \n[GitHub Profile](https://github.com/pfei)\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpfei%2Ftomate-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpfei%2Ftomate-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpfei%2Ftomate-cli/lists"}