pomo

package module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 9, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

README

🌳 Go Pomodoro Command Line Timer

GoDoc License Go Report Card

Install

This command can be installed as a standalone program or composed into a Bonzai command tree.

Standalone

go install github.com/arindas/pomo/cmd/pomo@latest

Composed

package z

import (
	Z "github.com/rwxrob/bonzai/z"
	"github.com/rwxrob/pomo"
)

var Cmd = &Z.Cmd{
	Name:     `z`,
	Commands: []*Z.Cmd{help.Cmd, pomo.Cmd},
}

Tab Completion

To activate bash completion just use the complete -C option from your .bashrc or command line. There is no messy sourcing required. All the completion is done by the program itself.

complete -C pomo pomo

If you don't have bash or tab completion check use the shortcut commands instead.

Embedded Documentation

All documentation (like manual pages) has been embedded into the source code of the application. See the source or run the program with help to access it.

Add Pomodoro to TMUX

Here's an example of how to add pomo to your TMUX configuration. Your mileage may vary.

set -g status-interval 1
set -g status-right "#(pomo)"

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Duration   = "52m" // max length of Twitch no-ad run
	Warn       = "1m"
	Prefix     = "🍅"
	PrefixWarn = "💢"
)
View Source
var Cmd = &Z.Cmd{
	Name: `pomo`,
	Commands: []*Z.Cmd{
		printCmd,
		help.Cmd, vars.Cmd, conf.Cmd,
		initCmd, startCmd, stopCmd,
	},
	Shortcuts: Z.ArgMap{
		`started`:    {`var`, `started`},
		`duration`:   {`var`, `set`, `duration`},
		`warn`:       {`var`, `set`, `warn`},
		`prefix`:     {`var`, `set`, `prefix`},
		`prefixwarn`: {`var`, `set`, `prefixwarn`},
	},
	Summary:   `sets or prints a countdown timer (with tomato)`,
	Version:   `v0.1.1`,
	Copyright: `(c) Robert S. Muhlestein <rob@rwx.gg> (rwxrob.tv)`,
	License:   `Apache-2.0`,
	Source:    `https://github.com/rwxrob/pomo`,
	Issues:    `https://github.com/rwxrob/pomo/issues`,

	Description: `
		The {{cmd .Name}} command is a simple tool to help people follow the  
	  Pomodoro method of time boxing. Many add 
		{{print "#(" .Name ")" | pre }}
		to their {{cmd "tmux"}} status lines and turn up the
		refresh to one second.`,
}

Functions

This section is empty.

Types

This section is empty.

Directories

Path Synopsis
cmd
pomo command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL