renest 0.1.15

Reference

How hand-offs work.

A hand-off gives one nest to someone you choose. You create a private link that expires, allows between one claim and a limit set by your plan, and can be revoked at any time. The recipient signs in, sees what the nest will run and where it fetches from, and claims it into their own drive. Nothing is copied: their drive points at the same checked files. There is no public link and no way to browse for one.

You send a nest by creating a link for one version of it

Open the nest in your drive and create a hand-off. A hand-off always points at one stored version, so the recipient gets exactly what you packed, not whatever the nest becomes later. Before the link is issued you confirm that you have the right to pass the contents on.

Renest refuses to create a hand-off in three cases: the nest is still being checked after upload; its dependencies could not be reinstalled on another machine, so the recipient would download it only to fail at setup; or it was stopped by our safety policy. In the last case the message does not say which file was the reason.

You get a link to send however you like. You can also enter the recipient's e-mail address and Renest sends the link for you. Hand-off links open on get.nesthandoff.com. Sending hand-offs needs a paid plan; how many you can create each month depends on the plan (see Pricing).

Every link expires and allows a limited number of claims

When you create a link you choose two things:

  • How long it stays valid. There is a default lifetime and a maximum; you can pick anything up to the maximum.
  • How many times it can be claimed. Any whole number from one up to the limit set by your plan (see Pricing). One means the first person to claim it uses it up. There is no unlimited option.

Your list of hand-offs shows each link's claims so far, its expiry date and when you created it. You can copy the link again from there at any time, and revoke it with one click.

The link shows a short summary to anyone who has it, and nothing more

Opening a hand-off link without signing in shows a summary. It changes nothing and cannot be used to download anything. It lists only these things:

  • the nest's name, total size, number of files and the date it was stored, and whether every file was checked on upload;
  • who sent it, shortened to the first letters of each name, and whether the sender packed it or received it from someone else;
  • the framework it rebuilds into, how many models of each kind it holds, how many custom nodes and input files it has, and the Python and CUDA versions it was locked to;
  • how many files the recipient will have to fetch themselves;
  • when the link expires, and whether it can be claimed only once.

It never shows file names, images, or an e-mail address. Sender names are shortened because links get pasted into forums and chats, and full names there could be collected into a list of who sends what. The page tells search engines not to index it, and each visitor is limited to a small number of requests a minute.

Claiming puts the nest in your drive without copying it

To claim, sign in and open the link, or paste the link or its code into the Redeem page. Any account can claim, including a free one. Before you claim, Renest shows what rebuilding the nest will do on your machine:

  • What runs: how many extensions and setup commands it contains, whether those extensions match their original repositories or were edited, and how many of its model files run code when they are loaded;
  • Where it fetches from: the hosts your machine will contact during the rebuild;
  • What you fetch yourself: the files whose licence does not let them be passed on.

Renest moves the sender's files exactly as they were packed. It does not inspect or vouch for them. So before the claim goes through, you confirm that you trust the sender. If the sender received the nest from someone else, you are told that, and asked whether you checked with them.

The claim moves no bytes. Your drive gets its own copy of the nest's record, pointing at the same stored files, and you restore it like any other nest. Files you did not already hold count toward your drive's space. Claiming the same nest twice, or a nest that is already yours, does nothing and does not use up a claim.

Files whose licence forbids passing them on stay behind

Some model files come with licences that do not allow redistribution, and some have no licence Renest can confirm. Those files are not given to the recipient from Renest's storage. The recipient's copy of the nest still lists each one by source address and content fingerprint, so they can download it themselves under their own account and terms, and the restore checks that it is the same file. Your own material, such as a LoRA you trained, travels normally.

The format spec describes the licence fields in the manifest that decide this.

A dead link says why it stopped working

A link stops working when it is revoked, expires, runs out of claims, when the sender deletes the nest, or when the sender closes their account. Opening a link in any of those states tells the recipient which one it is, so they know whether to ask for a new one.

Two cases give the same general message: a link that was never issued, and a hand-off that was stopped by safety policy after it was created. Saying more about the second would tell the sender what was caught.

Revoking a link stops future claims only. Anyone who already claimed keeps the nest: a hand-off gives permission to take a copy once, not ongoing access.

There is no public link, by design

Renest has no public link, no listing of hand-offs and no way to search for them. A link is a long random value that cannot be guessed. The short code you can type instead is stored only as a fingerprint, and is shown once when the hand-off is created. The list of hand-offs you can see contains only the ones you created. Every claim checks the link again against the stored record: status, expiry, claims used, the safety policy and the recipient's drive.

Renest works this way because of what a nest holds. It contains someone's working setup, including model files with licences attached and custom code that will run on the recipient's machine. A link that works for anyone who finds it is the wrong way to deliver that. A hand-off goes from a named sender to a recipient who has signed in, it can be revoked, and it can show what it contains before anyone claims it.

These docs describe renest 0.1.15, the latest release.

Open format

The docs describe a format you own.

Everything here is written against the open nest format. Every nest ships a plain restore.sh that brings back its files and dependencies with zero Renest code.