# KeibiDrop

> KeibiDrop connects exactly two computers and shows each other's shared files
> as a normal folder. Content streams on demand when read; edits sync back in
> under a second. End-to-end encrypted (hybrid ML-KEM-1024 + X25519), no cloud,
> no account. macOS, Linux, Windows. Three interfaces share one engine:
> the desktop app (keibidrop), a terminal REPL (keibidrop-cli), and kd, a
> non-interactive CLI for scripts and AI agents. Every kd command prints one
> JSON line {"ok":true,...}; check the "ok" field, not the exit code.
> All documentation pages are plain HTML without scripts.

## Docs
- [Documentation hub](https://keibidrop.com/docs/): all sections, terms table, agent notes

## Tutorials
- [Share a folder between two computers](https://keibidrop.com/docs/tutorials/share-a-folder.html): first session with the desktop app on one network
- [A first session in keibidrop-cli](https://keibidrop.com/docs/tutorials/terminal-session.html): REPL from start to a pulled file
- [Script a file transfer with kd](https://keibidrop.com/docs/tutorials/script-with-kd.html): two daemons on one machine, JSON in and out

## How-to guides
- [Install on macOS](https://keibidrop.com/docs/how-to/install-macos.html): Homebrew or DMG, macFUSE setup, FSKit
- [Install on Linux](https://keibidrop.com/docs/how-to/install-linux.html): .deb, fuse3, user_allow_other
- [Install on Windows](https://keibidrop.com/docs/how-to/install-windows.html): .zip or Chocolatey, WinFsp, drive letter
- [Connect two computers](https://keibidrop.com/docs/how-to/connect-two-computers.html): LAN one-click, fingerprint exchange, contacts
- [Work through firewalls and guest WiFi](https://keibidrop.com/docs/how-to/work-through-firewalls.html): IPv6 check, outbound-only bridge, strict_mode
- [Use git on a shared folder](https://keibidrop.com/docs/how-to/use-git.html): remote repos, clone, the two safety rules
- [Use vim, VS Code, and other editors](https://keibidrop.com/docs/how-to/use-editors.html): save patterns, conflicts, macOS live edits
- [Edit photos in GIMP and other image editors](https://keibidrop.com/docs/how-to/use-image-editors.html): tested save patterns, hand-off
- [Work on video and audio projects](https://keibidrop.com/docs/how-to/video-audio-projects.html): stream media, hand off project files, keep databases local
- [Run ffmpeg on remote files](https://keibidrop.com/docs/how-to/use-ffmpeg.html): transcode and clip without downloading first
- [Edit documents in LibreOffice and Word](https://keibidrop.com/docs/how-to/use-office-documents.html): office files across two machines
- [Work on Blender projects](https://keibidrop.com/docs/how-to/use-blender.html): assets stream, .blend hand-off, caches local
- [Use VS Code on a shared folder](https://keibidrop.com/docs/how-to/use-vscode.html): remote projects without SSH setup
- [Share an Obsidian vault](https://keibidrop.com/docs/how-to/use-obsidian.html): notes on two machines, one device at a time
- [Hand a database between machines](https://keibidrop.com/docs/how-to/hand-off-a-database.html): PostgreSQL and SQLite recipes, the one rule
- [Handle conflict files](https://keibidrop.com/docs/how-to/handle-conflict-files.html): recognize, resolve, avoid
- [Automate transfers with kd](https://keibidrop.com/docs/how-to/automate-with-kd.html): cron, CI, and agent recipes; check ok not exit codes
- [Run two instances on one machine](https://keibidrop.com/docs/how-to/run-two-instances.html): KEIBIDROP_CONFIG_DIR, sockets, ports
- [Collect logs and report a problem](https://keibidrop.com/docs/how-to/collect-logs-and-report.html): log paths, sanitized export
- [Troubleshoot connections](https://keibidrop.com/docs/how-to/troubleshoot-connections.html): discovery, internet, relay limits
- [Troubleshoot the mount](https://keibidrop.com/docs/how-to/troubleshoot-the-mount.html): drivers, permissions, stale mounts
- [Update or uninstall](https://keibidrop.com/docs/how-to/update-and-uninstall.html): per-platform commands, what stays behind

## Explanation
- [How KeibiDrop works](https://keibidrop.com/docs/explanation/how-keibidrop-works.html): two peers, on-demand streaming, relay and bridge roles
- [The security model](https://keibidrop.com/docs/explanation/security-model.html): PQ hybrid crypto, key rotation, relay visibility, honest non-claims
- [Edits, versions, and conflicts](https://keibidrop.com/docs/explanation/edits-versions-conflicts.html): last writer wins, conflict files, no silent loss
- [Network paths](https://keibidrop.com/docs/explanation/network-paths.html): LAN, direct IPv6, outbound-only bridge
- [What KeibiDrop is not](https://keibidrop.com/docs/explanation/what-keibidrop-is-not.html): scope boundaries

## Reference
- [kd command reference](https://keibidrop.com/docs/reference/kd-cli.html): all verbs, JSON envelope, exit-code warning, events, env vars
- [keibidrop-cli command reference](https://keibidrop.com/docs/reference/keibidrop-cli.html): REPL commands and startup
- [Desktop app reference](https://keibidrop.com/docs/reference/desktop-app.html): screens, controls, settings panel
- [Configuration reference](https://keibidrop.com/docs/reference/configuration.html): config.toml keys, env variables, precedence, booleans
- [Files and folders](https://keibidrop.com/docs/reference/files-and-folders.html): state, data, logs, runtime files per platform
- [Network and ports](https://keibidrop.com/docs/reference/network-ports.html): ports, endpoints, timings, limits
- [Platform support](https://keibidrop.com/docs/reference/platform-support.html): OS matrix, FUSE drivers, signing, mobile status
- [Limits and known issues](https://keibidrop.com/docs/reference/limits-and-known-issues.html): two peers, POSIX behavior, concurrent writing
- [Performance numbers](https://keibidrop.com/docs/reference/performance.html): measured throughput and latency with conditions

## Project
- [Releases](https://keibidrop.com/docs/releases.html): version history and current highlights
- [Roadmap](https://keibidrop.com/docs/roadmap.html): direction, no dates

## Optional
- [Homepage](https://keibidrop.com/): product overview
- [Use cases](https://keibidrop.com/use-cases.html): scenario walkthroughs
- [Repository](https://github.com/KeibiSoft/KeibiDrop): source, releases, SHA256SUMS