Languages: English / 简体中文

Upgit is a native & lightweight tool to helps you upload any file to your Github repository and then get a raw URL for it.

This is also useful with Typora as an image uploader.

• Support for Linux, Windows and macOS
• Upload any file to given remote github repo folder
• Upload from clipboard
• Custom auto renaming rules
• CDN via replacing rules
• Config via Environment Variable
• Output URL to stdout/clipboard, supports markdown image format

Download it from Release.

If you have no idea which to download:

• For most Windows users, choose upgit_win_amd64.exe
• For most macOS users, choose upgit_macos_arm64

Rename it to upgit (For Windows users, upgit.exe), save it to somewhere you like. To access it from anywhere, add its directory to the PATH environment variable.

Warning: this program doesn't contain an auto-updater. If you need to keep updated, just give upgit a ⭐star.

Create config.toml in the same directory of upgit, and fill it in following this sample config file.

To upload file logo.png with rename rules, execute:

./upgit logo.png
# for windows: .\upgit.exe logo.png

Then you'll see a link to logo.png.

To upload file logo.png to remote folder /my_images/demo, execute:

./upgit logo.png -t /my_images/demo
# for Windows: .\upgit.exe logo.png -t /my_images/demo

For more help, type -h argument

./upgit -h

Upload anything to git and then get its link.
For more information: https://github.com/pluveto/upgit

Usage: upgit.exe [--target-dir TARGET-DIR] [--verbose] [--size-limit SIZE-LIMIT] [--wait] [--clean] [--raw] [--output-type OUTPUT-TYPE] FILE [FILE ...]

Positional arguments:
  FILE                   local file path to upload. :clipboard for uploading clipboard image
Options:
  --target-dir TARGET-DIR, -t TARGET-DIR
                         upload file with original name to given directory. if not set, will use renaming rules
  --verbose, -V          when set, output more details to help developers
  --size-limit SIZE-LIMIT, -s SIZE-LIMIT
                         in bytes. overwrite default size limit (5MiB). 0 means no limit
  --wait, -w             when set, not exit after upload, util user press any key
  --clean, -c            when set, remove local file after upload
  --raw, -r              when set, output non-replaced raw url
  --output-type OUTPUT-TYPE, -o OUTPUT-TYPE
                         output type, support stdout(default), clipboard, clipboard-markdown [default: stdout]
  --help, -h             display this help and exit

Assuming your upgit program is saved at "C:\repo\upgit\upgit.exe".

Select File > Preferences...

Move to Image. Choose Custom Command as your Image Uploader.

Input upgit program location into Command textbox.

You can click Test Uploader button to make sure it works.

Now enjoy it!

Use :clipboard place holder for clipboard image. (Only supports png format)

./upgit :clipboard

Shortcuts for screenshot:

• On macOS, use Ctrl+Shift+Cmd+4
• On Linux/Ubuntu, use Ctrl+Shift+PrintScreen
• On Windows, use Shift+Win+s

Use --output-type clipboard-markdown:

./upgit logo.png --output-type clipboard-markdown
# or .\upgit.exe :clipboard -o clipboard-markdown

Then you'll get a markdown image link in your clipboard like:

![logo.png](!https://cdn.jsdelivr.net/gh/pluveto/upgit/logo.png)

For Windows user:

1. Install AHK

2. Create this script upload_clipboard.ahk and run:

   # Ctrl+F9 As shortcut
   ^F9::
   RunWait, explorer ms-screenclip:
   # use your own *upgit* program path
   RunWait, "upgit.exe" :clipboard --output-type clipboard-markdown
   return

3. Then press CtrlF9 to automatically take screenshot, upload it and get its link to your clipboard!

Here is a simplist sample config file:

pat = "ghp_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
rename = "{year}/{month}/upgit_{year}{month}{day}_{unix_ts}{ext}"
repo = "repo-name"
username = "username"

• UPGIT_TOKEN
• UPGIT_RENAME
• UPGIT_USERNAME
• UPGIT_REPO
• UPGIT_BRANCH

• Upload to specific folder
• Upload and get raw URL that is not replaced.
• Upload clipboard image
• Save uploaded image link to clipboard
• Upload from link
• Ignore uploaded file (link input)
• Upload history