COMMUTER

Synopsis

Ever wonder how long your commute home in traffic is going to take? Commuter is a CLI tool that will tell you what your commute looks like now and in the future.

Installation

On macOS, Linux, or OpenBSD run the following:

curl https://raw.githubusercontent.com/PennTex/commuter/master/install.sh | sh

Note that you may need to run the sudo version below, or alternatively chown /usr/local:

curl https://raw.githubusercontent.com/PennTex/commuter/master/install.sh | sudo sh

On Windows download binary.

You're now ready to use Commuter!

Usage

To use commuter you must first initialize the tool:

commuter init

To use commuter with the default values(work -> home), just type:

commuter

To add or delete addresses:

commuter add

commuter delete

To view all saved addresses:

commuter list

To view your commute in google maps:

# for default values(work -> home)
commuter view 

# for specific
commuter view -f home -t work

Options:

number: specify number of future commutes to show (default: 5)

commuter -n 20

interval: specify time between commute results in minutes (default: 15)

commuter -n 20 -i 10

from/to: specify which locations you which to use (default: work/home)

commuter -f work -t store

commuter -f home -t gym

start: specify when you will start your commute. Future times only. (default: current time)

Two syntaxs are accepted:

• MMDD:HHMM 24 hour clock example: 0712:1632 = July 12th 4:32PM
• MMDD:HHMM(AM|PM) 12 hour clock example: 0712:0432PM = July 12th 4:32PM

# start December 14th 4:00PM
commuter -s 1214:1600

# start December 14th 4:00PM
commuter -s 1215:0400PM

# start on current date at 5:00PM (currently only supports 24-hour clock - all times must be in the future)
commuter -s 1700

Contributors

Mario Harper

John Stamatakos

Copyright 2016