https://github.com/homerchen19/github-uploader

🔗 🖥 Upload attachments to GitHub in CLI. A simple and tricky way to get public URL to your files.
https://github.com/homerchen19/github-uploader

Last synced: 1 day ago
JSON representation

🔗 🖥 Upload attachments to GitHub in CLI. A simple and tricky way to get public URL to your files.

• Host: GitHub
• URL: https://github.com/homerchen19/github-uploader
• Owner: homerchen19
• License: mit
• Created: 2017-11-30T17:54:48.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-09-18T01:50:29.000Z (about 6 years ago)
• Last Synced: 2024-10-31T08:36:24.492Z (9 days ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/github-uploader
• Size: 189 KB
• Stars: 30
• Watchers: 3
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-list - github-uploader

README

        
# GitHub Uploader





















> Get public and free URL to your files.
 By

> [github-uploader](https://github.com/xxhomey19/github-uploader), you can let

> GitHub host your public files much more easier.

According to

[Official docs](https://help.github.com/articles/file-attachments-on-issues-and-pull-requests/),

GitHub supports these files now:

* PNG (.png)

* GIF (.gif)

* JPEG (.jpg)

* Log files (.log)

* Microsoft Word (.docx), Powerpoint (.pptx), and Excel (.xlsx) documents

* Text files (.txt)

* PDFs (.pdf)

* ZIP (.zip, .gz)

Notice that **the maximum size for files is 25MB and the maximum size for images

is 10MB**.

## Install 🛠

Please make sure that your terminal has installed [Node](https://nodejs.org/)

version **6.4.0 or higher**.

```

$ npm install -g github-uploader

```

It will register `github-uploader` and `gu` in your terminal.

## Usage 🖥

### Upload files

Enter the path of files which you would like to upload to GitHub.

```

$ github-uploader [file path]

```

**Note.**\

If you want to upload several files at the same time, separate each path with a space.\

File path can be relative path or absolute path.

## How it works ❓

I created a fake GitHub account named `xxxhomey19`.

Every time you upload files, `github-uploader` will log in to GitHub and pretend

to open a new issue in this repo. On that

[page](https://github.com/xxhomey19/github-uploader/issues/new), it can upload

your files.

Last of all, it parses all the content including file name and public URL and

show it in your terminal.

That's it 😋

## License

MIT © [xxhomey19](https://github.com/xxhomey19)