Skip to main content

Command-line interface for GNOME Pomodoro

Project description

Pomodoro Shell CLI

A command-line interface (CLI) for GNOME Pomodoro. Control your pomodoro timer from the terminal—start, pause, skip, or stop sessions without opening the app.

What is it?

Pomodoro Shell CLI connects to GNOME Pomodoro via D-Bus and lets you:

  • Check status — See the current timer state (pomodoro, short break, long break) and remaining time
  • Control the timer — Start, stop, pause, resume, or skip sessions from the command line
  • Watch mode — Run without arguments to display the state and auto-update when it changes

Useful for custom workflows, keyboard shortcuts, status bars (e.g. Waybar), or scripting.

Installation

From PyPI

pipx install pomodoro-shell-cli

Or with pip:

pip install pomodoro-shell-cli

With pipx (from Git)

pipx installs the tool in an isolated environment and makes the pomodoro command available globally. No system build dependencies required — the package uses pure Python D-Bus bindings.

pipx install git+https://github.com/pablogventura/pomodoro-shell-cli.git

From source

pip install -e .

Or run without installing (requires pip install dbus-fast first):

python -m pomodoro_shell_cli start

Requirements

Runtime: GNOME Pomodoro must be installed and running. On systems with GNOME, D-Bus and GLib are typically already available.

Usage

pomodoro [command]
Command Description
(none) Watch mode: show state and listen for changes
status Show current state once and exit
start Start a pomodoro
stop Stop the timer
pause Pause current session
resume Resume paused session
skip Skip to next (break or pomodoro)
reset Reset current timer

Examples

# Start a pomodoro
pomodoro start

# Pause it
pomodoro pause

# Skip to the break
pomodoro skip

# Check status
pomodoro status

# Run in watch mode (updates on every change)
pomodoro

License

GPL-3.0-or-later

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pomodoro_shell_cli-0.1.0.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pomodoro_shell_cli-0.1.0-py3-none-any.whl (17.6 kB view details)

Uploaded Python 3

File details

Details for the file pomodoro_shell_cli-0.1.0.tar.gz.

File metadata

  • Download URL: pomodoro_shell_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for pomodoro_shell_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6560d6954072bee47bcb2262ad5b8d47169ac9c2b10f3d35e2f312ec762d53c2
MD5 8044065f21de018fd778c4ee043070ab
BLAKE2b-256 12f21b7a6ed10523dd38efa2de91a9888917c43de7f3148bcccec09924e0c95a

See more details on using hashes here.

File details

Details for the file pomodoro_shell_cli-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pomodoro_shell_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2d0004effd40374750adbd74c60635d65680d18d070c420ca35b21c73112be9f
MD5 47de29766d3ff7d41cb557cc943cc53b
BLAKE2b-256 1bb03418faaf94c9fdabfd01e8ff5099969a738f387f04e5f7cdda2931c4dfb2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page