hovancik/stretchly

[Feature request]: Get current state from CLI

Open

#1628 opened on Aug 14, 2025

View on GitHub
 (3 comments) (1 reaction) (0 assignees)JavaScript (3,892 stars) (410 forks)batch import
enhancementhelp wanted

Description

Version

  • I'm using version 1.17.2

Existing requests

  • I've checked Existing requests

Advanced Preferences

  • I've checked Advanced Preferences

What operating system are you using?

Linux

Operating System Version

Linux Cuddles-Bobba 6.15.9-arch1-1 #1 SMP PREEMPT_DYNAMIC Sat, 02 Aug 2025 01:20:06 +0000 x86_64 GNU/Linux

Problem description

I would like to add Stretchly to my status bar (polybar to be exact). While it can be added as a tray icon, I want immediate access to more information like current pause state, time to next mini/long break, etc. Polybar (and other text statusbars) work by periodically running scripts and displaying their outputs, but stretchly CLI command does not seem to have a status command.

Possible solution

Add stretchly status command which displays relevant dynamic state information in script-friendly format, e.g. JSON. Example output:

{
    "seconds_paused": 0,  // implies unpaused
    "seconds_to_mini_break": 120,
    "seconds_to_long_break": 3600
}

Alternative solutions

Some of this information can already be deduced from logs and config, e.g.:

[2025-08-14 22:18:24.147] [info]  Stretchly: finishing Mini Break (shouldPlanNext: true)

combined with

	"microbreakInterval": 300000,

And current date 2025-08-14 22:21:45.481, you can calculate the next mini break to be in:

2025-08-14 22:21:45.481 - 2025-08-14 22:18:24.147 = 3min21s334ms
300000ms - 3m21s334ms = 5min - 3m21s334ms = 1m38s666ms

But the logs show not be considered a stable API, plus may fall apart on some edge cases (e.g. mini break timer resetting due to long break on pauses).

Additional information

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct

Contributor guide

Tech stack
javascriptelectronnodejs
Domain
clideveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Node.js/JavaScriptElectron app developmentCLI command implementation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Investigate the existing CLI command implementation in stretchly (likely in `src/` or `cli/`). Look for how the app's state (pause, break timers) is managed, e.g., in a main process or store. Then propose a new command that retrieves this state and outputs JSON. Check if there are any existing IPC or state management patterns. Consider using `commander` or similar library for CLI. Test the command with various states (paused, running, etc.).