2
0
mirror of https://github.com/alexanderepstein/Bash-Snippets synced 2018-11-08 02:59:35 +01:00
Bash-Snippets/README.md
2017-08-02 17:01:35 -04:00

12 KiB

Bash-Snippets

A collection of small bash scripts for heavy terminal users with no dependencies

Version Codacy Badge Build Status platform license

All of these scripts have been heavily tested on macOS and Linux

Most of these scripts have been tested on Windows 10 and the official developer bash instance. Does not work with Cygwin or Mysys2.

For a quick list and summary of the tools from the terminal run one of the following 4 lines compatible with your system

curl -A curl -s cheat.sh/~Bash-Snippets
http -b GET cheat.sh/~Bash-Snippets
wget -qO- cheat.sh/~Bash-Snippets
fetch cheat.sh/~Bash-Snippets

Cheat

The fastest way to find {command options|code pieces} you need

Supports multiple languages and many bash commands

Cloudup

A tool that facilitates backing up github repositories to bitbucket

If you have ever felt the fear of the github unicorn this could be your savior

Furthermore you can backup the repositories of any github user to your bitbucket.

Backup all github repositories of the designated user at once with the -a option. Or run it with no flags and backup individual repositories.

Crypt

A wrapper for openssl that allows for quickly encrypting and decrypting files

crypt -e [original file] [encrypted file] # encrypts files
crypt -d [encrypted file] [output file] # decrypts files

Encryption Details

  • Uses AES 256 level encryption
  • Key is salted before creation
  • Password is never in plain text, and OpenSSL generates key based on password
  • Encrypted data is encoded in Base64, so it can be used as plain text in an email. (Not usually necessary if attached as a file)

Tested With .pdf, .txt, .docx, .doc, .png, .jpeg

CAUTION Make sure to use different filenames, otherwise your file will be overwritten!

Cryptocurrency

Converts Cryptocurrency based on realtime exchange rates

If you want to bypass to guided input you can pass in 3 arguments and it will run from there ex.currency [baseCurrency] [exchangeToCurrency] [amountBeingExchanged] so a valid use case would be currency BTC USD 12.35

Written by: Jonas-Taha El Sesiy

Currency

Converts currency based on realtime exchange rates

If you want to bypass to guided input you can pass in 3 arguments and it will run from there ex.currency [baseCurrency] [exchangeToCurrency] [amountBeingExchanged] so a valid use case would be currency USD EUR 12.35

Geo

Provides data for wan, lan, router, dns, mac, and ip geolocation

Written by: Jake Meyer

Movies

Quick search that grabs relevant information about a movie

Newton

Performs numerical calculations all the way up to symbolic math parsing.

Qrify

Takes any string of text and turns it into a qr code

This is useful for sending links or saving a string of commands to your phone

Written by: Linyos Torovoltos

Short

Gets the link that is being masked by a url shortner

Siteciphers

Check which ciphers are enabled / disabled for a given https site.

Sometimes ciphers are deemed vulnerable, so when you are changing configuration, this can be used to confirm that the cipher truly is disabled.

Some browsers (For example old versions of IE) don't support some of the newer ciphers, which would be a good example of when a SysAdmin would need a list of currently supported ciphers so that changes can be made.

Stocks

Provides information about a certain stock symbol

Taste

Recommendation engine that provides three similar items like the supplied item

Also can provide information on a given item

Valid items are: shows, books, music, artists, movies, authors, games

Needs an API Key (don't worry it's free)

  • Get the API key here
  • After getting the API key run the following line export TASTE_API_KEY="yourAPIKeyGoesHere" >> ~/.bash_profile

todo

A simplistic command line todo list

Weather

Provides a 3 day forecast

With no arguments it will grab the weather for your location as determined by your ip

With arguments you can pass in a city or country and get the weather in that area

Also can show the current moon phase

Youtube-Viewer

Provides a way to watch youtube videos from the terminal.

You can use ytview -c [channel name] to see recent videos by that artist.

You can use ytview -s [videoToSearch] or just ytview [videoToSearch] to search for videos.

Written by: Linyos Torovoltos

API's Used

  • To get location based on ip address: ipinfo
  • To get and print weather based on a location: wttr
  • To grab the stock information in JSON format: alphavantage
  • To grab the latest exchange rate between currencies: fixer
  • To grab information on movies: omdbapi
  • To grab recommendations based on an item: tastedive
  • To determine masked link behind url shortner: x.datasig
  • To grab cheatsheets for commands and languages: cheat
  • To encode text into a qr code: qrenco
  • To grab a list of a users repositories: github
  • To upload a repository to bitbucket: bitbucket
  • To get your WAN ip address: ipify
  • To grab the latest exchange rate between cryptocurrencies to standard currencies: coinmarketcap
  • To perform symbolic math and other computations: newton

Inspired by: Ruby-Scripts

Installing

For macOS via homebrew

brew install bash-snippets # installs all tools
brew install bash-snippets --without-all-tools --with-newton --with-weather # specifying install for individual tools

For Sparrowhub users

sparrow plg install [tool]

For Arch Linux Users

There is an AUR package for bash-snippets located here

Otherwise

  • First clone the repository: git clone https://github.com/alexanderepstein/Bash-Snippets

  • Then cd into the cloned directory: cd Bash-Snippets

  • Git checkout to the latest stable release git checkout v1.17.3

  • Run the guided install script with

./install.sh

this will let you choose which scripts to install

  • Install all the scripts
./install.sh all
  • Install an individual script
./install.sh stocks

Updating

For macOS if installed via homebrew

brew upgrade bash-snippets

Otherwise

With any of the installed tools you can automate the update by running it with the -u option or passing in update as the arguments Ex.

stocks update

or

stocks -u

This will clone the repository and install the new versions of scripts that were installed, if you didn't install a certain tool this script will not install the new version of that tool.

Uninstalling

For macOS if installed via homebrew

brew uninstall bash-snippets

Otherwise

  • If you don't have the Bash-Snippets folder anymore clone the repository: git clone https://github.com/alexanderepstein/Bash-Snippets

  • cd into the Bash-Snippets directory: cd Bash-Snippets

To go through a guided uninstall

./uninstall.sh

To uninstall all installed bash-snippets

./uninstall.sh all

Donate

If this project helped you in any way and you feel like buying a broke college kid a cup of coffee

Donate Donate

License

MIT License

Copyright (c) 2017 Alex Epstein

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.