croc

<p align="center">
  <a href="https://getcroc.com"><img src="web/src/assets/croc.jpg" width="408px" border="0" alt="croc"></a>
  <br>
  <a href="https://github.com/schollz/croc/releases/latest"><img src="https://img.shields.io/github/v/release/schollz/croc" alt="Version"></a>
  <a href="https://github.com/schollz/croc/actions/workflows/ci.yml"><img src="https://github.com/schollz/croc/actions/workflows/ci.yml/badge.svg" alt="Build Status"></a>
  <a href="https://github.com/sponsors/schollz"><img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/schollz"></a>
</p>
<p align="center">
  <strong>This project’s future depends on community support. <a href="https://github.com/sponsors/schollz">Become a sponsor today</a>.</strong>
</p>


## About

`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:

- Allows **any two computers** to transfer data (p2p with relay fallback)
- Provides **end-to-end encryption** (using PAKE)
- Enables easy **cross-platform** transfers (Windows, Linux, Mac, [Browser](https://getcroc.com))
- Allows **multiple file** transfers
- Allows **resuming transfers** that are interrupted
- No need for local server or port-forwarding
- **IPv6-first** with IPv4 fallback
- Can **use a proxy**, like Tor

For more information about `croc`, see [my blog post](https://schollz.com/tinker/croc6/) or read a [recent interview I did](https://console.substack.com/p/console-91).

![Example](src/install/customization.gif)

## No-install

You can use croc without installing anything at [getcroc.com](https://getcroc.com).

The browser version is fully compatible with the CLI, so you can send and receive files between them.

## Install

You can download [the latest release for your system](https://github.com/schollz/croc/releases/latest), or install a release from the command-line:

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

The installer places **croc** and **croc-update** in the same directory. Standalone
release archives include both binaries too. To upgrade:

```bash
croc update       # check croc and prepare the updater when needed
croc-update       # update the croc active on PATH
```

The updater shows download progress with transferred bytes. Each command asks
before changing a binary. Pass `--yes` to each command to skip
its confirmation. Protected directories such as `/usr/local/bin` may still
require authentication: the command requests `sudo` or `doas` on Unix, or UAC
approval on Windows. Writable custom prefixes work without elevation:

```bash
curl https://getcroc.com | bash -s -- -p "$HOME/.local/bin"
```

`croc update --check` reports croc release availability without installing;
`croc-update --check` checks the croc active on `PATH`. Direct helper use selects
that executable first, including a user-owned installation such as
`$HOME/go/bin/croc`. If croc is absent from `PATH`, it installs be