> Documentation index: https://rift.sh/llms.txt

# Get started

Install Rift, create a key and share a folder.

## Install

```
$ curl -fsSL https://rift.sh/install | sh
✓ installed rift 0.1.0 to ~/.local/bin
```

One binary for macOS and Linux. A background process starts the first time you run a command and handles sync from then on.

## Create your key

```
$ rift init
✓ created a key for this machine
  ed25519:7f3a91c0…3a4b5c
✓ folder at ~/rift
```

`rift init` makes this machine's key and a folder, `~/rift`. Everything in that folder is an ordinary file. `rift id` prints the full public key, which is what a coworker needs to share a folder with you. There is no account to create.

The private key never leaves this machine. No one can reset it. If you lose it, you lose access to every folder shared with that key.

## Share your first folder

Alice makes a folder, puts a file in it, and shares it with Bob's key.

```
# alice
$ mkdir ~/rift/team
$ cp notes.md ~/rift/team/
$ rift peer add ed25519:c4d5e6f7…b3c4d5 --alias bob
✓ saved bob
$ rift share team bob
✓ shared team with bob · write
```

Bob's machine already has the folder. He ran no command to receive it.

```
# bob
$ ls ~/rift/team
notes.md
$ cat ~/rift/team/notes.md
ship friday
$ cp reply.md ~/rift/team/
```

`reply.md` appears in Alice's folder without either of them running a sync command. Next: [roles and subfolders](https://rift.sh/docs/sharing.md), or [adding an agent](https://rift.sh/docs/guides.md#agents).