mux
Copy and sync files between machines. One command on each side sends a folder anywhere, through home routers, with every byte checked.
curl -fsSL https://mux.yuvich.com/install.sh | sh
$ mux cp ./photos peer: seeding photos (23.17 MiB, 28 chunks) mux://c11f…
$ mux cp 'mux://c11f…' ./downloads/ saved ./downloads/photos (23.17 MiB, verified)
What it does
- Send
- One command offers a folder and prints a ticket. One command with that ticket fetches it on another machine. There is no account and no port to open.
- Reach
- It works when both machines are behind home routers. They connect directly where they can, and through an encrypted relay where they cannot.
- Check
- Every chunk is compared with its digest before it is written. A file gets its name only when all of it is right.
- Resume
- A copy that is cut off carries on when you run the same command again.
- Sync
mux syncmakes a folder match its source and fetches only what changed. Nothing is removed unless you ask, and what is replaced goes to a trash folder first.- Download
- Give it a web address. It fetches a file in several parts at once, and can read from your other machines at the same time.
- Scripts
--jsonon every command, and exit codes that say whether running it again is worth it. An agent can read llms.txt.
Install
- macOS, Linux
- Run the line at the top. It downloads the build for your machine, checks it and puts
muxin~/.local/bin. Run it again to upgrade. - Homebrew
brew install yuvichh/tap/mux- Nix
nix profile install github:yuvichh/mux, which builds the current source.- Windows
- Download mux.exe and put it in a folder on your
PATH. - Checksums
- The SHA-256 sum of every download is in checksums-sha256.txt.
Documentation
- Start here
- Send a folder, sync it and download from the web, step by step.
- Commands
- Every command and flag, what is written for a program, and the exit codes.
- How it works
- Tickets, chunks and checking, in pictures.
- Protocol
- What two machines say to each other.