Skip to content

Latest commit

 

History

History
216 lines (122 loc) · 7.77 KB

README.md

File metadata and controls

216 lines (122 loc) · 7.77 KB
Raw

getme

CLI utility for everyday tasks

With getme you can get weather, forecast, currency rate, upload files, IP address, word definitions, text translations, internet speed, do google searches, get inspirational quotes and get Chuck Norris jokes.

✨ All from the terminal ✨

NPM

npm Travis npm Coverage Status

Install it globally

npm i getme -g

Getme Options

command definition
getme -h, --help or getme [COMMAND] -h, --help Output usage information
getme chuck Displays a random Chuck Norris joke
getme cur, currency [base] [currs] Get currency rates against a base currency (default base USD, default currencies All)
getme d, definition [word] Get word definitions (Only works for english words)
getme d, definition -s [word] Get synonyms of a specific word (Only works for english words)
getme dt, date [options] [value] Get x days from now, and the corresponding day of the week
getme f, forecast [unit] Get weather forecast of 5 days ahead, default unit is Celsius
getme git Get new notifications from GitHub
getme repo Opens current Github project page in the browser
getme ip Get public and network IP addresses
getme q, quote Displays an inspirational quote and its author
getme s, search [query] Search in Google
getme speed Get internet speed based on speedtest
getme t, translation [options] Get translations of text from a language to another
getme tw, search [query] Search on twitter
getme u, upload [filepath][options] Uploads a file to file.io and generates a link for you to share that file
getme w, weather [unit] Get weather, default unit is Celsius, can be celsius, fahrenheit, or kelvin

Google search

getme search dogs and cats Opens browser, searching for "dogs and cats"

getme-search

GitHub notifications

getme git Option to open selected notification in browser also.

Github Repository

getme repo Open current Github project repository in the browser

Weather and forecast

getme weather Weather in celsius

getme weather -f Weather in fahrenheit

getme forecast Forecast of five days ahead in celsius

getme forecast -f Forecast of five days ahead in fahrenheit

getme-weather

Currency rates

getme currency -s JPY,BRL,CAD Get JPY, BRL and CAD currencies where base currency is USD (USD is default if no base currency is set)

getme currency -b EUR -s USD,BRL Get USD and BRL currency where base currency is EUR

getme-currency

Currency options

Most common base currencies to be passed as parameter:

  • USD (Dollar) Default
  • EUR (Euro)

For entire list of possible currency initials: European Central Bank

Public and network IP addresses

getme ip

getme-ip

Internet download/upload speed, and your ping

getme speed

getme-speed

Word definitions (Only works for english words)

getme definition chair Get definitions for the word chair

getme-definition

Word synonyms

getme definition -s teacher Get synonyms for the word teacher

Text translations

getme translation --fromto en-pt --text The book is on the table Translate from English to Portuguese "the book is on the table" becomes "O livro está sobre a mesa"

getme translation --fromto es-en --text El libro está sobre la mesa Translate from Spanish to English "El libro está sobre la mesa" becomes "The book is on the table"

All text after the --text flag will be interpreted as text to be translated

--fromto works as a pair of language codes separated by a hyphen ("from"-"to"). For example, en-ru indicates translating from English to Russian.

To get a list of all the possible --fromto combinations, type

getme translation --list or getme translation -l

getme-translation

Inspirational quotes

getme quote getme q

getme-quote

Upload files and generate links

Usage: getme upload 'path/to/file' Example: getme upload ~/Desktop/test.txt

Setting custom link expiration

Example: getme upload ~/Desktop/test.txt -e 1w

File is uploaded and link will expire in one week

If no expiration is declared, default link expiration is 14 days

Expiration can be in

  • days. Example: '1d', '10d'
  • weeks. Example: '1w', '5w'
  • months. Example: '1m', '5m'
  • years. Example: '1y', '5y'

getme-upload

Twitter search

  • getme tweets #node #npm
  • getme tw node npm

You can search by using @ or #.

Example

Important:

After the file is downloaded from the generated link, just once, this link will no longer work, it will be destroyed. They call file.io the snapchat for files

File is anonymous and is erased after link expires also, and cannot be retrieved later by accesing the generated link

Read more in file.io

Dates calculation

Usage: getme date|dt [value]

  • value - Integer value of period to add/subtract
  • --period, -p - Specify the period of time (See momentJS Keys)
  • --date, -d - Specify the base date to manipulate (Default: Today)
  • --add, -a - Set the current action to add to date (This is the default option)
  • --subtract, -s - Set the current action to subtract to date (Not compatible with add parameter)

Examples

Add 5 days to current date getme date 5

Add 10 days to specific date getme dt 10 -d 2017-05-01

Subtract 2 months getme dt 2 --period M -d 2017-05-01

And much more 🚀

Contributing

We'd love to have your helping hand on getme!

See CONTRIBUTING.md for more information on what we're looking for and how to get started.

License

MIT License @ Gabriel Godoy