Quick Start

This walks you through creating a shared space and syncing a folder with someone on another machine. It takes a couple of minutes.

1. Open Nimbreth

Launch Nimbreth. On first run it picks a sensible home for your files, so there is nothing to configure. You land in your workspace, ready to create a space.

2. Create a space

A space is a folder that Nimbreth keeps in sync. Create one and give it a name, like whatever you are working on. Nimbreth sets up the folder and starts watching it for changes.

If you would rather use a folder you already have, point Nimbreth at it instead. Before it binds the folder, Nimbreth scans it once and flags anything sensitive it finds (keys, credentials, and the like) so you can exclude those files or confirm before anything syncs.

3. Copy the share key

Every space has a share key: a short string that identifies it on the network. Copy it with one click. Anyone you give it to can join the space, so send it through a channel you trust, the way you would a password.

4. They join

On the second machine, the other person installs Nimbreth, opens it, and pastes the share key. The space appears on their machine and starts syncing right away. That is their whole onboarding: one key, and they are in.

5. Add files

Put files into the space the way you would any folder: drag them in, or save into it from another app. Everything you add syncs to everyone in the space.

6. Watch it sync

Nimbreth shows you what is happening: which peers are connected, whether the space is up to date, and when it last synced. Changes flow both ways, so edits made on either machine show up on the other.

Next steps

Something not working? Ask on Discord or email hello@nimbreth.com.