pace-timer
v0.0.1
Published
Pace yourself with this command line timer
Downloads
3
Readme
About Pace
Pace is a Typescript app that performs a countdown timer using a visual renderer on the command line. Choose a renderer when you run the app, or run preview to see a representation of all the renderers.
Usage
USAGE
$ pace [DURATION] [RENDERER]
ARGUMENTS
DURATION duration in (m)inutes and (s)seconds (eg 3m10s = 190 seconds)
RENDERER the timer renderer:
bar, bigtext, circles, colorwheel, colossal, pie, renderers, shuffle, slant, sweep
DESCRIPTION
Displays a progress timer
EXAMPLES
$ pace 2.5m pie
The Shuffle Renderer
Use the shuffle
renderer to preview all renderers in action. This renderer switches to another renderer every 10 seconds.
pace 5m shuffle
Preview All Renderers
pace tools preview
Contributing
It would be great to see more renderers! To write a new renderer add a subclass of src/renderers/TimerRenderer
and register it with
a short name in src/renderers/AllRenderers
.
Preview All Available Figlet Fonts
pace tools allfonts
Preview All Available Colors and Gradients
pace tools colorblocks
Notes
- Renderers should not store state between callbacks, since the
shuffle
renderer andtools preview
command depend on calling renderers at selected intervals.
Built With
- Typescript
- Yarn
- Oclif