Skip to content

Latest commit

 

History

History
97 lines (68 loc) · 4.04 KB

README.md

File metadata and controls

97 lines (68 loc) · 4.04 KB

sha1sum: cb5123d6faa573fa673f11eeefad6b8a08a23a30

Buy Me a Coffee at ko-fi.com

NAME

    rugmi - Upload images to imgur.com and print their links.

SYNOPSIS

    rugmi [-dts0h] -f FILE

DESCRIPTION

    Upload images to imgur.com and print their links.
	
    On first execution, rugmi will ask you to authorize by providing Client ID, Client Secret and a PIN code.
    Once Client ID and Client Secret are provided, if available, xdg-open will be used to open up a browser to log you in imgur.com and get the PIN code.
    Otherwise, you'll be requested to manually copy-paste an authorization link into your browser.

    After providing the PIN code, an access token and refresh token will be requested from imgur.com
    and will be stored in ~/.rugmi_tokens (077 umask) along with Client ID and Client Secret.

    After setup is complete, rugmi will automatically upload FILES to imgur.com.

    Rugmi will ask imgur.com for new access token once expired.

OPTIONS

    -f,--file FILE              Select a FILE to upload.
    -0,--null                   Read null terminated file names from stdin.
    -d,--delete SECONDS         Delete images SECONDS seconds after they've been uploaded.
    -t,--link-type TYPE         Choose what type of link to print after upload.
    -s,--display-size SIZE      Select the display size of the uploaded image.

    -- FILES                    Ignore any options to come.
                                Everything after this option is considered a file.
    -h,--help                   Show this message and exit successfully.

     Link types:
        * Direct   (email & IM) - Default
        * Image    (email & IM)
            The uploaded image as it is hosted in imgur.com, with all the fun stuff around.
            This type of link will ignore any display size ( if provided via -s,--display-size )
        * Markdown (reddit comments)
        * HTML     (website/blogs)
        * BBCode   (message boards & forums)
        * LBBCode  (Linked BBCode suitable for message boards)

     Display size options:
        * O  (Original) - Default
        * SS (Small square)
        * BS (Big square)
        * ST (Small thumbnail)
        * MT (Medium thumbnail)
        * LT (Large thumbnail)
        * HT (Huge thumbnail)

EXAMPLES

    Upload foo.png, bar.png, baz.png and print the result links to stdout.
    $ rugmi -f foo.png -f bar.png -f baz.png
        or
    $ rugmi -- foo.png bar.png baz.png
    
    Upload foo.png, print the result link to stdout
    and delete the file from imgur.com servers after 15 seconds.
    $ rugmi -d 15 -f foo.png

    Upload all JPEG files in a directory and print the result links to stdout.
    $ find dir/ -type f -name '*.jpg' -print0 | rugmi -0

    Upload foo.png and print an HTML type of link to be displayed as a medium thumbnail.
    rugmi -f foo.png -t HTML -s MT

Author

Rany Albeg Wein - [email protected]

License

Copyright (C) 2019 Rany Albeg Wein - [email protected]

This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.