4.6 KiB
curl https://getcroc.schollz.com | bash
croc is a tool that allows any two computers to simply and securely transfer files and folders. AFAIK, this is the only CLI file-transfer tool that:
- enables cross-platform transferes (Windows, Linux, Mac)
- enables secure peer-to-peer transferring (through a relay)
- allows multiple file transfers
- allows resuming transfers that are interrupted
- does not require a server or port-forwarding
For more information on how croc works, see my blog post.
Install
Download the latest release for your system, or install a release from the command-line:
$ curl https://getcroc.schollz.com | bash
Or, you can install Go and build from source (requires Go 1.11+):
go get github.com/schollz/croc
Usage
To send a file, simply do:
$ croc send FILE
Sending 'FILE' (X MB)
Code is: code-phrase
Them to receive the file on another computer, you can just do
$ croc code-phrase
The code phrase is used to establish password-authenticated key agreement (PAKE) which generates a secret key for the sender and recipient to use for end-to-end encryption.
Custom code phrase
You can send with your own code phrase (must be more than 4 characters).
$ croc send --code [code-phrase] [filename]
Use pipes - stdin and stdout
You can pipe to croc:
$ cat [filename] | croc send
In this case croc will automatically use the stdin data and send and assign a filename like "croc-stdin-123456789". To receive to stdout at you can always just use the --yes and --stdout flags which will automatically approve the transfer and pipe it out to stdout.
$ croc --yes --stdout [code-phrase] > out
All of the other text printed to the console is going to stderr so it will not interfere with the message going to stdout.
Self-host relay
The relay is needed to staple the parallel incoming and outgoing connections. By default, croc uses a public relay but you can also run your own relay:
$ croc relay
Make sure to open up TCP ports (see croc relay --help for which ports to open).
You can send files using your relay by entering --relay to change the relay that you are using if you want to custom host your own.
$ croc --relay "myrelay.example.com:9009" send [filename]
License
MIT
Acknowledgements
croc has been through many iterations, and I am awed by all the great contributions! If you feel like contributing, in any way, by all means you can send an Issue, a PR, ask a question, or tweet me (@yakczar).
Thanks @warner for the idea, @tscholl2 for the encryption gists, @skorokithakis for code on proxying two connections. Finally thanks for making pull requests @Girbons, @techtide, @heymatthew, @Lunsford94, @lummie, @jesuiscamille, @threefjord, @marcossegovia, @csleong98, @afotescu, @callmefever, @El-JojA, @anatolyyyyyy, @goggle, @smileboywtu, @nicolashardy!