Skip to content

README.md

Latest commit

 

History

History
270 lines (184 loc) · 13.4 KB

README.md

File metadata and controls

270 lines (184 loc) · 13.4 KB
Raw

KeibiDrop

Website · Download · Blog

Open files on another computer without downloading them first

KeibiDrop demo, Mac and Windows side by side. Click to watch on YouTube with sound.
Mac to Windows, one folder, nothing to download first. Two computers side by side. Click to watch on YouTube, with sound.

Another computer's files show up as a folder on yours, and you open and edit them in your own apps with nothing to download first.

  • A big file opens right away, because only the parts you read cross the network, and your edits save back.
  • No cloud stores your files, and the relay that connects you cannot read them, because they are end-to-end encrypted with protection against future quantum computers.
  • On the same network you connect with one click. Over the internet you swap a code once and then save the contact.
  • With Teleport on, your friend's files are a real folder on your computer, so any app works with them, git clone included.
  • It runs on macOS, Linux, Windows and Android, and iOS is on the way. The code is open source under the AGPL-3.0.

Get it: Mac · Windows · Linux · Android · every click, per computer · or try it on the web

Getting started: install it on both computers and connect once. On the same Wi-Fi, turn on Local mode; anywhere else, send your code in any chat and paste your friend's code. Then drop a file in, or open their files with Teleport. Each step has a short clip, and the clips are also a YouTube playlist.

Connecting two computers with a code: Copy my code, paste it in a chat, paste the other code, press Connect on both sides. Click to watch the two minute video on YouTube.
Copy your code, send it in any chat, paste your friend's code, and both of you press Connect.

KeibiDrop connection screen

With direct transfer, you drag files in and your friend saves the ones they need. With Teleport, your friend's files appear as a folder that any app can open.
The app in direct transfer mode The app with Teleport on
Finder shows the Teleport Folder like any other folder. git works inside the Teleport Folder.
Shared files in Finder git in the Teleport Folder

Install

macOS

brew tap keibisoft/keibidrop
brew trust keibisoft/keibidrop
brew install keibidrop

Linux (Debian/Ubuntu)

wget -O keibidrop.deb $(curl -s https://api.github.com/repos/KeibiSoft/KeibiDrop/releases/latest \
  | grep -o 'https://[^"]*_amd64\.deb')
sudo apt install ./keibidrop.deb

Windows

choco install keibidrop

Or download from GitHub Releases.

Android

We host our own F-Droid repository. Open fdroid.keibisoft.com on your phone, scan the code, and check the fingerprint before you add it.

To add it by hand, use https://fdroid.keibisoft.com/fdroid/repo in F-Droid under Settings, Repositories. The fingerprint to check is on the same page.

Build from source

git clone https://github.com/KeibiSoft/KeibiDrop.git
cd KeibiDrop
make build-kd       # CLI daemon
make build-cli      # Interactive CLI
make build-rust     # Desktop UI (needs Rust + Slint)

Quick start

On the same network:

  1. You and your friend both open KeibiDrop and turn on Local mode.
  2. Your computers find each other.
  3. Click your friend's computer to connect.
  4. Share files.

Over the internet:

  1. You and your friend both open KeibiDrop.
  2. Copy your code and send it to your friend in any chat.
  3. Paste each other's codes and both press Connect.
  4. Share files.

Save your friend as a contact to skip the code exchange next time.

KeibiDrop works through firewalls. When a direct connection fails, it uses an encrypted relay, so you need no port forwarding and no router setup.

Direct transfer and Teleport

With direct transfer you add files and your friend saves the ones they need. It needs nothing extra and suits sending large files.

With Teleport your friend's files appear as a folder on your computer, which suits working on shared files and git repositories. It needs a driver installed once: macFUSE on a Mac, fuse3 on Linux or WinFsp on Windows.

Connection and encryption

  1. The two computers exchange codes, or find each other on the local network.
  2. KeibiDrop picks the fastest path: the local network, a direct connection or the encrypted relay.
  3. Files cross an encrypted channel that the relay cannot read.
  4. Keys rotate during the session for forward secrecy.

The encryption is post-quantum (ML-KEM-1024 + X25519) with AES-256-GCM or ChaCha20-Poly1305. Full protocol details in Security.md.

Interfaces

Desktop UI (Rust/Slint)

./keibidrop

Interactive CLI (terminal REPL)

./keibidrop-cli

Agent CLI (for scripts and AI agents, all output is JSON)

./kd start                           # Start daemon
./kd show fingerprint                # Get your fingerprint
./kd register <peer-fingerprint>     # Register peer
./kd create                          # Create room (or: kd join)
./kd add /path/to/file.zip           # Share a file
./kd list                            # List shared files
./kd pull file.zip ~/Downloads/      # Download a file

See docs/kd-agent-guide.md.

Configuration

KeibiDrop reads ~/.config/keibidrop/config.toml. Environment variables override the config.

Setting Env var Default
Relay server KD_RELAY https://keibidroprelay.keibisoft.com/
Bridge relay KD_BRIDGE bridge.keibisoft.com:26600
Save folder KD_SAVE_PATH ~/KeibiDrop/Received/
Teleport Folder KD_MOUNT_PATH ~/KeibiDrop/Mount/
Inbound port KD_INBOUND_PORT 26431
Teleport off KD_NO_FUSE false
Security

Post-quantum hybrid key exchange prevents future quantum computers from decrypting recorded traffic. Forward secrecy via periodic re-keying limits exposure if a session key is ever compromised.

By default, identity persists across sessions (so saved contacts keep working), encrypted with a per-install master key stored in the OS keychain (macOS Keychain Services, Linux Secret Service, Windows Credential Manager). Headless setups fall back to ~/.config/keibidrop/.master.key (mode 0600). A passphrase (Argon2id) can protect it for users who back up the config to a cloud. Incognito mode uses a new key pair for each session and writes nothing to disk, so two sessions cannot be linked.

Full protocol description: Security.md

Troubleshooting

See TROUBLESHOOTING.md.

Contributing

See CONTRIBUTING.md.

License

From version 0.5.0 the engine, CLI, mobile bindings and desktop UI are licensed under the GNU Affero General Public License v3.0 (AGPL-3.0-only). A closed-source product that embeds or links them needs a commercial license.

Mobile apps and brand assets: Proprietary - see LICENSING.md

Desktop UI built with Slint

Built by KeibiSoft SRL.

By trade

Remote DFIR triage

Remote triage without a VPN: 20 GB mounted, 606 MB moved

Mount an evidence share read only across NAT and extract the artifact set you need, with no inbound port, native on Windows, and no kernel driver on the evidence machine. There is a write-up and a DFIR page.

Post-production handoff

DaVinci Resolve playing a clip that lives on a NAS 400 km away, then jumping to the next clip, which is there when the playhead lands on it. Click to watch the two minute demo on YouTube.
Your footage stays on the studio NAS, and DaVinci Resolve opens it on demand while you travel, with no download or upload to wait for. Click for the two minute demo.

Mount the camera originals and skip the proxy transcode before the handoff and the relink after it. The Resolve setup goes step by step.

Datasets on a rented GPU box

Mount the workstation that holds the data, with no bucket and no upload before the first batch.

An always-on box, such as a NAS

Two terminals. Left: a container on a NAS prints its code and Peer connected. Right: a laptop adds the box as a contact, connects, lists the shared folder and hashes one photo through the mount

A session needs both machines online, and a NAS or a home server stays online all the time. The container in docker/ runs the serving side on that box from plain Docker with the stock kernel. Your laptop mounts the folder from anywhere and reads on demand, so only the bytes a program reads cross the wire. In that run the box, a container on a server in Timisoara, served 161 files to a laptop in Bucharest; after it paired once, the laptop listed the folder and hashed one photo. Setup is one compose file, in the guide. An Unraid template is in docker/unraid/.

Photographers and editors

The raws and the footage stay on the box at the studio. The laptop mounts the folder, Lightroom or Resolve opens the files from the mount, and each file moves only when it is opened; a 1 MiB read out of a big file moves one 16 MiB block. The catalog stays on the laptop, as the post-production page and the video and audio guide describe. Set the share read only when the box is the archive and the laptop must change nothing.

Agents, and the data they work on

Two agents pairing over MCP: the laptop offers a 2,184 file dataset in place, the gpu box lists it and reads shards off the mount

Two agents, one per machine, each drive a KeibiDrop peer through the MCP server. The laptop offers a folder where it sits, and the gpu box mounts it and checksums 24 shards out of 2,184 files six folders deep. In that run 88,581 bytes crossed the network out of 6,784,286 on disk, because that is what it opened. The whole thing, pairing included, took 12.5 seconds.

Build it with make build-kdmcp, then kdmcp install prints the config snippet for your MCP client. Sending stays off until KD_SHARE_ROOT names one directory to send from, so a receiving agent cannot be talked into shipping files out.

Links