gimme

Peer-to-peer file transfer client and server with an accomponying cross-platform GUI
git clone https://git.sebsite.pw/clone/gimme.git
Log | Files | Refs | README | LICENSE

README.md (1422B)


      1 # Gimme
      2 
      3 Gimme is a peer-to-peer file transfer client and server written in Go, with an
      4 accompanying cross platform GUI written in Tcl/Tk. It was created out of
      5 frustration that I couldn't easily transfer a large file between two devices
      6 that were right next to each other without relying on a third party cloud
      7 storage provider (USB wasn't an option for various reasons).
      8 
      9 ## Usage
     10 Run `gimme` with no arguments to see the usage. Some examples:
     11 
     12 ```
     13 # start a server to listen for files on port 42069
     14 gimme receive 42069
     15 
     16 # same as above: if no port is specified, gimme defaults to 42069
     17 gimme receive
     18 
     19 # send the file msg.txt to the server running on local port 42069
     20 gimme send :42069 msg.txt
     21 
     22 # send a message from standard input to a server running on an external network
     23 gimme send example.com:42069 << .
     24 Hello there!
     25 yes im using port 42069 do you have a problem with that
     26 .
     27 ```
     28 
     29 ## Building and stuff
     30 The base client and server depends on Go. Use `go build` to build the
     31 executable.
     32 
     33 The GUI frontend depends on Tcl and Tk. The easiest way to run it is by using
     34 Wish. Run `wish gui.tcl` or alternatively `./gui.tcl` if your system supports
     35 shebangs (`#!/usr/bin/env wish`).
     36 
     37 ## Contributing and things like that
     38 This software isn't complete (I still need to add support for encryption, for
     39 instance). If you want to contribute for some reason, I can be reached at
     40 sebastian at sebsite dot pw. I accept patches. :)