mirror of
https://github.com/schollz/croc.git
synced 2025-10-11 13:21:00 +02:00
update ui and readme
This commit is contained in:
parent
462fad8d8e
commit
7377f536fc
4 changed files with 27 additions and 44 deletions
65
README.md
65
README.md
|
@ -5,7 +5,6 @@
|
||||||
width="408px" border="0" alt="croc">
|
width="408px" border="0" alt="croc">
|
||||||
<br>
|
<br>
|
||||||
<a href="https://github.com/schollz/croc/releases/latest"><img src="https://img.shields.io/badge/version-6.0.0-brightgreen.svg?style=flat-square" alt="Version"></a>
|
<a href="https://github.com/schollz/croc/releases/latest"><img src="https://img.shields.io/badge/version-6.0.0-brightgreen.svg?style=flat-square" alt="Version"></a>
|
||||||
<img src="https://img.shields.io/badge/coverage-77%25-brightgreen.svg?style=flat-square" alt="Code coverage">
|
|
||||||
<a href="https://travis-ci.org/schollz/croc"><img
|
<a href="https://travis-ci.org/schollz/croc"><img
|
||||||
src="https://img.shields.io/travis/schollz/croc.svg?style=flat-square" alt="Build
|
src="https://img.shields.io/travis/schollz/croc.svg?style=flat-square" alt="Build
|
||||||
Status"></a>
|
Status"></a>
|
||||||
|
@ -15,10 +14,15 @@ Status"></a>
|
||||||
|
|
||||||
<p align="center"><code>curl https://getcroc.schollz.com | bash</code></p>
|
<p align="center"><code>curl https://getcroc.schollz.com | bash</code></p>
|
||||||
|
|
||||||
*croc* is a tool that allows any two computers to simply and securely transfer files and folders. There are many tools that can do this but AFAIK *croc* is the only tool that is easily installed and used on any platform, *and* has secure peer-to-peer transferring (through a relay), allows multiple files, *and* has the capability to resume broken transfers.
|
`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](https://schollz.com/software/croc).
|
For more information on how `croc` works, see [my blog post](https://schollz.com/software/croc6).
|
||||||
|
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
@ -44,75 +48,59 @@ To send a file, simply do:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ croc send FILE
|
$ croc send FILE
|
||||||
|
Sending 'FILE' (X MB)
|
||||||
|
Code is: code-phrase
|
||||||
```
|
```
|
||||||
|
|
||||||
Them to receive the file, you can just do
|
Them to receive the file on another computer, you can just do
|
||||||
|
|
||||||
```
|
```
|
||||||
$ croc [code-phrase]
|
$ croc code-phrase
|
||||||
```
|
```
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
### Custom code phrase
|
### Custom code phrase
|
||||||
|
|
||||||
You can send with your own code phrase (must be more than 4 characters).
|
You can send with your own code phrase (must be more than 4 characters).
|
||||||
|
|
||||||
```
|
```
|
||||||
$ croc send --code [code phrase] [filename]
|
$ croc send --code [code-phrase] [filename]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Use locally
|
|
||||||
|
|
||||||
*croc* automatically will attempt to start a local connection on your LAN to transfer the file much faster. It uses [peer discovery](https://github.com/schollz/peerdiscovery), basically broadcasting a message on the local subnet to see if another *croc* user wants to receive the file. *croc* will utilize the first incoming connection from either the local network or the public relay and follow through with PAKE.
|
### Use pipes - stdin and stdout
|
||||||
|
|
||||||
You can change this behavior by forcing *croc* to use only local connections (`--local`) or force to use the public relay only (`--no-local`):
|
You can pipe to `croc`:
|
||||||
|
|
||||||
```
|
|
||||||
$ croc --local/--no-local send [filename]
|
|
||||||
```
|
|
||||||
|
|
||||||
### Using pipes - stdin and stdout
|
|
||||||
|
|
||||||
You can easily use *croc* in pipes when you need to send data through stdin or get data from stdout. To send you can just use pipes:
|
|
||||||
|
|
||||||
```
|
```
|
||||||
$ cat [filename] | croc send
|
$ 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.
|
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
|
$ 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.
|
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
|
### Self-host relay
|
||||||
|
|
||||||
The relay is needed to staple the parallel incoming and outgoing connections. The relay temporarily stores connection information and the encrypted meta information. The default uses a public relay at, `croc4.schollz.com`. You can also run your own relay, it is very easy, just run:
|
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
|
$ croc relay
|
||||||
```
|
```
|
||||||
|
|
||||||
Make sure to open up TCP ports (see `croc relay --help` for which ports to open). Relays can also be customized to which elliptic curve they will use (default is siec).
|
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 `-addr` to change the relay that you are using if you want to custom host your own.
|
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 -addr "myrelay.example.com" send [filename]
|
$ croc --relay "myrelay.example.com:9009" send [filename]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Configuration file
|
|
||||||
|
|
||||||
You can also make some paramters static by using a configuration file. To get started with the config file just do
|
|
||||||
|
|
||||||
```
|
|
||||||
$ croc config
|
|
||||||
```
|
|
||||||
|
|
||||||
which will generate the file that you can edit.
|
|
||||||
Any changes you make to the configuration file will be applied *before* the command-line flags, if any.
|
|
||||||
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
@ -120,11 +108,6 @@ MIT
|
||||||
|
|
||||||
## Acknowledgements
|
## 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](http://ctt.ec/Rq054)).
|
`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](http://ctt.ec/Rq054)).
|
||||||
|
|
||||||
Thanks...
|
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 [@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)!
|
||||||
|
|
||||||
- ...[@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/).
|
|
||||||
- ...for making pull requests [@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)!
|
|
||||||
|
|
|
@ -212,7 +212,7 @@ func receive(c *cli.Context) (err error) {
|
||||||
}
|
}
|
||||||
|
|
||||||
func relay(c *cli.Context) (err error) {
|
func relay(c *cli.Context) (err error) {
|
||||||
debugString := "warn"
|
debugString := "info"
|
||||||
if c.GlobalBool("debug") {
|
if c.GlobalBool("debug") {
|
||||||
debugString = "debug"
|
debugString = "debug"
|
||||||
}
|
}
|
||||||
|
|
|
@ -223,7 +223,7 @@ func (c *Client) Send(options TransferOptions) (err error) {
|
||||||
machID = machID[:6]
|
machID = machID[:6]
|
||||||
}
|
}
|
||||||
c.machineID = machID
|
c.machineID = machID
|
||||||
fmt.Fprintf(os.Stderr, "Sending %s (%s) from your machine, '%s'\n", fname, utils.ByteCountDecimal(totalFilesSize), machID)
|
fmt.Fprintf(os.Stderr, "Sending %s (%s)\n", fname, utils.ByteCountDecimal(totalFilesSize))
|
||||||
fmt.Fprintf(os.Stderr, "Code is: %s\nOn the other computer run\n\ncroc %s\n", c.Options.SharedSecret, c.Options.SharedSecret)
|
fmt.Fprintf(os.Stderr, "Code is: %s\nOn the other computer run\n\ncroc %s\n", c.Options.SharedSecret, c.Options.SharedSecret)
|
||||||
// // c.spinner.Suffix = " waiting for recipient..."
|
// // c.spinner.Suffix = " waiting for recipient..."
|
||||||
// c.spinner.Start()
|
// c.spinner.Start()
|
||||||
|
|
|
@ -73,7 +73,7 @@ func (s *server) start() (err error) {
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *server) run() (err error) {
|
func (s *server) run() (err error) {
|
||||||
log.Debugf("starting TCP server on " + s.port)
|
log.Infof("starting TCP server on " + s.port)
|
||||||
server, err := net.Listen("tcp", ":"+s.port)
|
server, err := net.Listen("tcp", ":"+s.port)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return errors.Wrap(err, "Error listening on :"+s.port)
|
return errors.Wrap(err, "Error listening on :"+s.port)
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue