croc/README.md

48 lines
966 B
Markdown
Raw Normal View History

2017-10-18 03:13:08 +02:00
# croc
2017-10-17 17:21:47 +02:00
2017-10-18 03:13:08 +02:00
*File transfer over parallel TCP with a rendezvous server.*
2017-10-17 17:21:47 +02:00
2017-10-18 03:13:08 +02:00
This is more or less a Golang port of [magic-wormhole](https://github.com/warner/magic-wormhole) except it probably isn't secure.
2017-10-17 17:21:47 +02:00
2017-10-18 03:13:08 +02:00
# Install
2017-10-17 17:21:47 +02:00
```
2017-10-18 03:13:08 +02:00
go get github.com/schollz/croc
2017-10-17 17:21:47 +02:00
```
2017-10-18 03:13:08 +02:00
# Basic usage
2017-10-17 17:21:47 +02:00
2017-10-18 03:13:08 +02:00
## Send a file
2017-10-17 17:21:47 +02:00
2017-10-18 03:13:08 +02:00
On computer 1 do:
2017-10-17 17:21:47 +02:00
```
2017-10-18 03:13:08 +02:00
$ croc -send somefile
Your code phrase is now limbo-rocket-gibson
waiting for other to connect
2017-10-17 17:21:47 +02:00
```
2017-10-18 03:13:08 +02:00
## Receive a file
2017-10-17 17:21:47 +02:00
2017-10-18 03:13:08 +02:00
Just type `croc` and you'll be prompted for the code phrase. Use the code phrase to get the file.
2017-10-17 17:21:47 +02:00
```
2017-10-18 03:13:08 +02:00
$ croc
What is your code phrase? limbo-rocket-gibson
0s [====================================================] 100%
Downloaded somefile!
2017-10-17 17:21:47 +02:00
```
2017-10-18 03:13:08 +02:00
# Advanced usage
## Make your own rendezvous server
On some server you have, `your-server.com`, just run
2017-10-17 17:21:47 +02:00
```
2017-10-18 03:13:08 +02:00
$ croc -relay
2017-10-17 17:21:47 +02:00
```
2017-10-18 03:13:08 +02:00
Now, when you use *croc* to send and receive you can add `-server your-server.com` to use your rendezvous server.