Go to file
meyermarcel a23347a823 Replace deprecated 'archive' key with new 'archives' key (#129) 2019-05-10 11:58:53 -07:00
src bump version 2019-05-10 07:16:00 -06:00
.travis.yml Add publishing to homebrew repository (#128) 2019-05-10 06:11:14 -07:00
LICENSE Create LICENSE 2017-10-18 11:50:06 -06:00
README.md bump version 2019-05-10 07:16:00 -06:00
go.mod update deps 2019-05-09 22:58:28 -06:00
go.sum update deps 2019-05-09 22:58:28 -06:00
goreleaser.yml Replace deprecated 'archive' key with new 'archives' key (#129) 2019-05-10 11:58:53 -07:00
main.go add go generate code for updating version 2019-05-02 13:14:09 -07:00

README.md

croc
Version Build
Status Say thanks

curl https://getcroc.schollz.com | bash

croc is a tool that allows any two computers to simply and securely transfer files and folders. AFAIK, croc is the only CLI file-transfer tool does all of the following:

  • allows any two computers to transfer data (using a relay)
  • provides end-to-end encryption (using PAKE)
  • enables easy cross-platform transfers (Windows, Linux, Mac)
  • allows multiple file transfers
  • allows resuming transfers that are interrupted
  • does not require a server or port-forwarding

For more information about croc, 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 -v github.com/schollz/croc/v6

Or, on macOS you can install the latest release with Homebrew:

$ brew install schollz/tap/croc

Usage

To send a file, simply do:

$ croc send [file(s)-or-folder]
Sending 'file-or-folder' (X MB)
Code is: code-phrase

Them to receive the file (or folder) 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] [file(s)-or-folder]

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 will automatically approve the transfer and pipe it out to stdout.

$ croc --yes [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!