Installation

Install go-pomodoro with npm, Go, or from source.

Installation

You can install go-pomodoro with npm or Go.

Requirements

For the npm package:

• Node.js 16 or newer
• npm

For the Go install:

• Go installed on your machine

Install with npm

Use npm if you want the easiest install:

npm install -g go-pomodoro

After installation, check that the command is available:

pomodoro version

Start your first timer:

pomodoro start

Install with Go

Use Go if you prefer installing directly from the source module:

go install github.com/imSaikirann/go-pomodoro@latest

Make sure your Go binary directory is in your PATH.

On many systems, this directory is:

~/go/bin

Then check the command:

pomodoro version

Run from source

Clone the repository:

git clone https://github.com/imSaikirann/go-pomodoro
cd go-pomodoro

Run the CLI:

go run .

Run a command through Go:

go run . start
go run . status
go run . sessions

Windows PowerShell notes

If PowerShell says that a command is not recognized, close and reopen your terminal after installing.

If npm scripts are blocked by PowerShell execution policy, use npm.cmd:

npm.cmd install -g go-pomodoro

Then run:

pomodoro version

Update

If you installed a released binary, you can try:

pomodoro update

Development builds cannot update themselves. If you installed from source, pull the latest code and rebuild or rerun:

git pull
go run .

Uninstall

If you installed with npm:

npm uninstall -g go-pomodoro

If you installed with Go, remove the pomodoro binary from your Go binary directory.