croc/README.md

203 lines
7.2 KiB
Markdown
Raw Normal View History

2018-06-28 14:09:11 +02:00
2018-07-02 00:12:46 +02:00
<p align="center">
<img
2018-10-10 04:08:07 +02:00
src="https://user-images.githubusercontent.com/6550035/46709024-9b23ad00-cbf6-11e8-9fb2-ca8b20b7dbec.jpg"
width="408px" border="0" alt="croc">
2018-07-02 00:12:46 +02:00
<br>
2020-10-04 22:16:35 +02:00
<a href="https://github.com/schollz/croc/releases/latest"><img src="https://img.shields.io/badge/version-v8.4.0-brightgreen.svg?style=flat-square" alt="Version"></a>
2019-11-26 18:50:16 +01:00
<a href="https://coveralls.io/github/schollz/croc"><img src="https://img.shields.io/badge/coverage-81%25-green.svg?style=flat-square" alt="Coverage"></a>
2018-10-11 16:33:35 +02:00
<a href="https://travis-ci.org/schollz/croc"><img
2019-02-02 05:14:27 +01:00
src="https://img.shields.io/travis/schollz/croc.svg?style=flat-square" alt="Build
2018-10-11 16:33:35 +02:00
Status"></a>
2018-07-02 00:12:46 +02:00
</p>
2018-06-28 14:09:11 +02:00
2020-09-18 19:42:34 +02:00
`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 that does **all** of the following:
2018-06-28 14:09:11 +02:00
2019-05-03 01:06:57 +02:00
- 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)
2019-05-02 21:08:23 +02:00
- allows **multiple file** transfers
- allows **resuming transfers** that are interrupted
2019-09-07 17:18:21 +02:00
- local server or port-forwarding **not needed**
2020-09-04 18:00:30 +02:00
- **ipv6-first** with ipv4 fallback
2018-06-28 14:09:11 +02:00
2019-05-03 01:06:57 +02:00
For more information about `croc`, see [my blog post](https://schollz.com/software/croc6).
2018-10-21 20:34:31 +02:00
2020-05-08 20:00:07 +02:00
![Example](src/install/customization.gif)
2018-10-20 16:14:36 +02:00
2018-07-07 15:46:40 +02:00
## Install
2018-07-02 00:12:46 +02:00
2019-05-01 21:20:30 +02:00
Download [the latest release for your system](https://github.com/schollz/croc/releases/latest), or install a release from the command-line:
2018-10-13 19:50:29 +02:00
```
$ curl https://getcroc.schollz.com | bash
```
2019-05-01 21:20:30 +02:00
2019-05-12 16:54:03 +02:00
On macOS you can install the latest release with [Homebrew](https://brew.sh/):
2019-05-01 21:20:30 +02:00
2018-10-13 19:50:29 +02:00
```
2020-09-19 02:07:55 +02:00
$ brew install croc
2018-10-13 19:50:29 +02:00
```
On macOS you can also install the latest release with [MacPorts](https://macports.org/):
```
$ sudo port selfupdate
$ sudo port install croc
```
2018-07-02 00:12:46 +02:00
On Windows you can install the latest release with [Scoop](https://scoop.sh/) or [Chocolatey](https://chocolatey.org):
```
2019-05-12 16:54:03 +02:00
$ scoop install croc
```
```
$ choco install croc
```
2019-08-14 01:09:13 +02:00
On Unix you can install the latest release with [Nix](https://nixos.org/nix):
```
$ nix-env -i croc
```
2019-05-12 16:54:03 +02:00
2019-11-13 01:41:41 +01:00
On Arch Linux you can install the latest release with `pacman`:
```
$ pacman -S croc
```
2019-12-23 16:57:44 +01:00
On Ubuntu you can install with `snap`:
```
$ snap install croc
```
On Gentoo you can install with `portage`:
```
$ emerge net-misc/croc
```
On Termux you can install with `pkg`:
```
$ pkg install croc
```
2020-09-26 13:01:29 +02:00
On FreeBSD you can install with `pkg`:
```
$ pkg install croc
```
2019-07-20 17:57:03 +02:00
Or, you can [install Go](https://golang.org/dl/) and build from source (requires Go 1.12+):
2019-05-12 16:54:03 +02:00
```
2020-02-29 01:57:46 +01:00
$ GO111MODULE=on go get -v github.com/schollz/croc/v8
```
2019-05-01 21:20:30 +02:00
2018-07-07 15:46:40 +02:00
## Usage
2018-06-28 14:09:11 +02:00
2019-05-01 21:20:30 +02:00
To send a file, simply do:
2018-06-28 14:09:11 +02:00
2018-07-02 00:12:46 +02:00
```
2019-05-03 02:06:11 +02:00
$ croc send [file(s)-or-folder]
2019-05-03 01:37:43 +02:00
Sending 'file-or-folder' (X MB)
2019-05-02 21:08:23 +02:00
Code is: code-phrase
2018-07-02 00:12:46 +02:00
```
2018-06-28 14:09:11 +02:00
Then to receive the file (or folder) on another computer, you can just do
2018-06-28 14:09:11 +02:00
2018-07-07 15:46:40 +02:00
```
2019-05-02 21:08:23 +02:00
$ croc code-phrase
2018-07-07 15:46:40 +02:00
```
2018-06-28 14:09:11 +02:00
2019-05-02 21:08:23 +02:00
The code phrase is used to establish password-authenticated key agreement ([PAKE](https://en.wikipedia.org/wiki/Password-authenticated_key_agreement)) which generates a secret key for the sender and recipient to use for end-to-end encryption.
2019-07-18 15:22:03 +02:00
There are a number of configurable options (see `--help`). A set of options (like custom relay, ports, and code phrase) can be set using `--remember`.
2019-05-03 01:37:43 +02:00
2018-07-07 15:46:40 +02:00
### Custom code phrase
You can send with your own code phrase (must be more than 4 characters).
2018-06-28 14:09:11 +02:00
2018-07-02 00:12:46 +02:00
```
2019-05-03 02:06:11 +02:00
$ croc send --code [code-phrase] [file(s)-or-folder]
2018-07-02 00:12:46 +02:00
```
2018-06-28 14:09:11 +02:00
2019-05-02 21:08:23 +02:00
### Use pipes - stdin and stdout
2018-07-07 15:46:40 +02:00
2019-05-02 21:08:23 +02:00
You can pipe to `croc`:
2018-06-28 14:09:11 +02:00
2018-07-07 15:46:40 +02:00
```
$ cat [filename] | croc send
```
2018-06-28 14:09:11 +02:00
2019-05-03 01:37:43 +02:00
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`.
2018-06-28 14:09:11 +02:00
2018-07-07 15:46:40 +02:00
```
2019-05-03 01:37:43 +02:00
$ croc --yes [code-phrase] > out
2018-07-07 15:46:40 +02:00
```
2018-06-28 14:09:11 +02:00
2019-05-02 22:40:14 +02:00
All of the other text printed to the console is going to `stderr` so it will not interfere with the message going to `stdout`.
2018-06-28 14:09:11 +02:00
### Send text
Sometimes you want to send URLs or short text. In addition to piping, you can easily send text with `croc`:
```
$ croc send --text "hello world"
```
This will automatically tell the receiver to use `stdout` when they receive the text so it will be displayed.
2018-07-07 15:46:40 +02:00
### Self-host relay
2018-06-28 15:38:07 +02:00
2019-05-02 21:08:23 +02:00
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:
2018-06-28 14:09:11 +02:00
2018-07-07 15:46:40 +02:00
```
$ croc relay
```
2018-06-28 14:09:11 +02:00
By default it uses TCP ports 9009-9013. Make sure to open those up. You can customized the ports (e.g. `croc relay --ports 1111,1112`), but you must have a minimum of **2** ports for the relay. The first port is for communication and the subsequent ports are used for the multiplexed data transfer.
2018-06-28 14:09:11 +02:00
2019-05-02 21:08:23 +02:00
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.
2018-06-28 14:09:11 +02:00
2018-07-02 00:12:46 +02:00
```
2019-05-02 21:08:23 +02:00
$ croc --relay "myrelay.example.com:9009" send [filename]
2018-07-02 00:12:46 +02:00
```
2018-06-28 14:09:11 +02:00
Note, when sending, you only need to include the first port (the communication port). The subsequent ports for data transfer will be transmitted back to the user from the relay.
2019-12-23 16:55:10 +01:00
#### Self-host relay (docker)
If it's easier you can also run a relay with Docker:
```
$ docker run -d -p 9009-9013:9009-9013 -e CROC_PASS='YOURPASSWORD' schollz/croc
```
2017-10-17 17:21:47 +02:00
2019-12-23 16:55:10 +01:00
Be sure to include the password for the relay otherwise any requests will be rejected.
```
$ croc --pass YOURPASSWORD --relay "myreal.example.com:9009" send [filename]
```
Note: when including `--pass YOURPASSWORD` you can instead pass a file with the password, e.g. `--pass FILEWITHPASSWORD`.
2018-07-07 15:46:40 +02:00
## License
2018-07-02 00:12:46 +02:00
MIT
2018-07-07 15:46:40 +02:00
## Acknowledgements
2020-07-17 21:54:10 +02:00
`croc` has gone 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](http://ctt.ec/Rq054)).
2018-07-02 00:12:46 +02:00
2020-08-26 19:00:56 +02:00
Thanks [@warner](https://github.com/warner) for the [idea](https://github.com/warner/magic-wormhole), [@tscholl2](https://github.com/tscholl2) for the [encryption gists](https://gist.github.com/tscholl2/dc7dc15dc132ea70a98e8542fefffa28), [@skorokithakis](https://github.com/skorokithakis) for [code on proxying two connections](https://www.stavros.io/posts/proxying-two-connections-go/). Finally thanks for making pull requests [@maximbaz](https://github.com/maximbaz), [@meyermarcel](https://github.com/meyermarcel), [@Girbons](https://github.com/Girbons), [@techtide](https://github.com/techtide), [@heymatthew](https://github.com/heymatthew), [@Lunsford94](https://github.com/Lunsford94), [@lummie](https://github.com/lummie), [@jesuiscamille](https://github.com/jesuiscamille), [@threefjord](https://github.com/threefjord), [@marcossegovia](https://github.com/marcossegovia), [@csleong98](https://github.com/csleong98), [@afotescu](https://github.com/afotescu), [@callmefever](https://github.com/callmefever), [@El-JojA](https://github.com/El-JojA), [@anatolyyyyyy](https://github.com/anatolyyyyyy), [@goggle](https://github.com/goggle), [@smileboywtu](https://github.com/smileboywtu), [@nicolashardy](https://github.com/nicolashardy), [@fbartels](https://github.com/fbartels), [@rkuprov](https://github.com/rkuprov), [@xenrox](https://github.com/xenrox) and [Ipar](https://github.com/lpar)!