/owo.sh

Shell uploader/shortener script. Authors: @jakeoid, @OkashiOdayakana, @jomo

Primary LanguageShellMIT LicenseMIT

owo.sh

A basic example/uploader for uploading to owo-whats-th.is's image server. The aim was to have a script that allowed for users of all operating systems (that werent already supported by ShareX) to also be able to upload to whats-th.is related products.

Thank you to jomo and his script jomo/imgur-screenshot, to which taking snippets and borrowing code has guided me to improving my own script. This script wouldn't be anywhere near what it is today without his efforts.

Install

dependencies

os dependency description
MacOS Terminal Notifier Default OSX Notifications suck and barely work, this is a workaround for that.
Screencapture Comes default with OSX and is the client that you use when you press CMD + Shift 3 or CMD + Shift 4.
Pbcopy Comes default with OSX and is used to copy things to your clipboard.
GREP Comes standard with all UNIX OSes and is used to (in this case) decipher JSON.
cURL Comes standard with all UNIX OSes and is used to (in this case) upload to the owo server.
Linux Notify-Send Default Linux barely has any, if at all, notification support from terminal. This is a workaround.
Maim A rich screenshotting client, that better than what comes default with Linux.
XClip Comes default with most UNIX based OSes and allows for things to copied to clipboards.
GREP Comes standard with all UNIX OSes and is used to (in this case) decipher JSON.
cURL Comes standard with all UNIX OSes and is used to (in this case) upload to the owo server.

##instructions

  1. Clone the repo with git clone https://github.com/whats-this/owo.sh.git
  2. Make sure script.sh has permissions: chmod a+x script.sh.
  3. Download the dependencies, you can check what you need with ./script.sh --check
  4. Put your token inside of conf.cfg, in userkey="YOURUSERKEY"
  5. Run the command ./setup.sh to add the owo command.
  6. You can now run owo file.png from anywhere to upload file.png.

Usage

Basic usage of the script is like so.

owo image.png

However the following flags can be placed after owo for the each of the results.

short command description
-h --help Shows this help screen to you, displaying all the avaliable commands.
-v --version Show current application version, incase you wanted to reference it elsewhere.
-c --check Checks whether or not dependencies are installed. Response with a INFO : or and ERROR : .
--update Checks whether or not your application is completely up to date. If not it will alert you.
-l --shorten Begins the url shortening process. This can be done through application or another argument.
-s --screenshot Begins the screenshot uploading process. Your OS should be able to guide you through this however.

Using the Mac Workflow

  1. Unzip the workflow file owo-uploader.workflow.zip
  2. Click on the workflow file. When prompted to install, click yes.
  3. Go to System Preferences > Keyboard > Shortcuts > Services
  4. Scroll down to General and look for owo-uploader. Assign a shortcut to it.
  5. (Optional) Disable default screenshot keys in System Preferences > Keyboard > Shortcuts > Screen Shots

Now when you press your selected shortcut, the screenshot uploader will be launched, without having to type anything in the shell.

Contribute

  1. Fork repo.
  2. Edit code.
  3. Make a PR.
  4. Submit said PR.

License

A copy of the MIT license can be found in LICENSE.md.