https://github.com/jackhftang/tusc
Single small binary for both TUS server and client
https://github.com/jackhftang/tusc
tus tus-protocol tusc
Last synced: 4 months ago
JSON representation
Single small binary for both TUS server and client
- Host: GitHub
- URL: https://github.com/jackhftang/tusc
- Owner: jackhftang
- License: mit
- Created: 2019-07-21T06:18:49.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-25T08:48:44.000Z (over 3 years ago)
- Last Synced: 2025-12-18T16:54:48.861Z (7 months ago)
- Topics: tus, tus-protocol, tusc
- Language: Go
- Homepage:
- Size: 43.9 KB
- Stars: 28
- Watchers: 0
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tusc
[](https://travis-ci.org/jackhftang/tusc)
TUS **C**ommand line (tusc) is a small static binary for both server and client of [tus resumable upload protocol](https://tus.io).
Personally, I need tusc for uploading files in a CI process and a simple UI for downloading (like nginx autoindex).
The chunked and resumable feature make it possible to bypass some payload size limitation imposed by proxy (e.g. cloudflare).
Also, small size of binary make it convenient to be included in docker image.
## Quick Start
Visit [releases page](https://github.com/jackhftang/tusc/releases) and download the tusc binary.
```bash
$ curl -LO https://github.com/jackhftang/tusc/releases/download//tusc_linux_amd64 -o tusc
$ chmod u+x tusc
```
Start server
```bash
$ tusc server -b 127.0.0.1 -p 8080
```
Create and upload a file
```bash
$ echo test > test.txt
$ tusc client http://127.0.0.1:8080/files/ text.txt # not resumable
$ tusc client http://127.0.0.1:8080/files/ text.txt -r # resumable
```
And then visit to [file listing page](http://127.0.0.1:8080)
## Command
### Server
TUSC is a wrapper of [tusd](https://github.com/tus/tusd) with an additional listing page.
Features like S3, GCS, Prometheus, Hooks are removed from tusd, in favor of smaller binary size.
#### Options
```
$ tusc s --help
tusc server
Usage:
tusc (server|s) [options]
tusc (server|s) --help
Options:
-u --url URL Url of HTTP server [default: http://localhost:1080]
-b --bind ADDR Address to bind HTTP server to [default: 0.0.0.0]
-p --port PORT Port to bind HTTP server to [default: 1080]
-d --dir PATH Directory to store uploads in [default: ./data]
--listing-endpoint PATH Http path for flies listing [default: /]
--files-endpoint PATH Http path for files [default: /files/]
--unix-sock PATH If set will listen to a UNIX socket at this location instead of a TCP socket
--max-size SIZE Maximum size of a single upload in bytes [default: 0]
--store-size BYTE Size of space allowed for storage [default: 0]
--timeout TIMEOUT Read timeout for connections in milliseconds. A zero value means that reads will not timeout [default: 30*1000]
--behind-proxy Respect X-Forwarded-* and similar headers which may be set by proxies [default: false]
```
### Client
TUSC is a command line implementation of this excellent library [go-tusd](https://github.com/eventials/go-tus).
#### Options
```
$ tusc c --help
tusc client
Usage:
tusc (client|c) [-H ]... [options]
tusc (client|c) --help
Options:
-r --resumable Save meta data for resumable uploads [default: false]
--store PATH Path to save meta data for resume [default: ./.tusc]
--chunk-size BYTE Size of chunks of file [default: 2097152]
--override-patch-method Sending a POST request instead of PATCH [default: false]
```