mirror of
https://github.com/coalaura/up.git
synced 2025-07-17 21:44:35 +00:00
UPdate readme
This commit is contained in:
14
README.md
14
README.md
@ -1,31 +1,29 @@
|
|||||||
# UP
|
|
||||||
|
|
||||||
UP is a simple file transfer tool that acts as a drop-in replacement for `scp` and `sftp`. It sends data over HTTPS for much faster uploads without any extra setup. The client uses your existing SSH keys and reads `~/.ssh/config` so you can keep working with the host aliases you already have.
|
UP is a simple file transfer tool that acts as a drop-in replacement for `scp` and `sftp`. It sends data over HTTPS for much faster uploads without any extra setup. Up uses your existing SSH keys and reads `~/.ssh/config` so you can keep working with the host aliases you already have.
|
||||||
|
|
||||||
## Why UP?
|
## Why UP?
|
||||||
|
|
||||||
- Transfers are noticeably quicker than traditional `scp` or `sftp`.
|
- Transfers are noticeably quicker than traditional `scp` or `sftp`.
|
||||||
- No setup: use the same SSH keys and host aliases you already have.
|
- No setup: use the same SSH keys and host aliases you already have.
|
||||||
- Small client and server binaries.
|
- Small single binary for sending and receiving.
|
||||||
|
|
||||||
## Quick Start
|
## Quick Start
|
||||||
|
|
||||||
Pre-built binaries for common operating systems are available in the [releases](https://github.com/coalaura/up/releases/latest). Choose the download that matches your OS and architecture or build the latest development version yourself:
|
Pre-built binaries for common operating systems are available in the [releases](https://github.com/coalaura/up/releases/latest). Choose the download that matches your OS and architecture or build the latest development version yourself:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
go build -o server ./server
|
go build -o up .
|
||||||
go build -o up ./client
|
|
||||||
```
|
```
|
||||||
|
|
||||||
Start the server (listens on port 7966) and then upload a file:
|
Start the server (listens on port 7966) and then upload a file:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
./server
|
./up receive
|
||||||
|
|
||||||
./up very_big.tar.xz localhost:7966
|
./up send very_big.tar.xz localhost:7966
|
||||||
```
|
```
|
||||||
|
|
||||||
Uploaded files are stored under the server's `files/` directory. The client will prompt to trust the server's certificate on first use and will remember it afterwards. Up is built to work behind reverse proxies like nginx.
|
Uploaded files are stored under the server's `files/` directory. Up will prompt to trust the server's certificate on first use and will remember it afterwards. Up is built to work behind reverse proxies like nginx.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
2
test.cmd
2
test.cmd
@ -1,3 +1,3 @@
|
|||||||
@echo off
|
@echo off
|
||||||
|
|
||||||
go run .\client test.bin localhost:7966
|
go run . send test.bin localhost:7966
|
Reference in New Issue
Block a user