Skip to main content

renest

Pack up a GPU setup you already got working — an image workflow or a fine-tuning run — and rebuild it on any other machine, every file byte for byte. Boot that machine from the image your nest recorded, and everything the app needs comes with it.

Renest is for the moment after something works. You got a ComfyUI workflow producing the image you wanted, or a fine-tuning run that finally trained. Renest captures everything that success depended on — models, custom nodes, code, the dependency lock, the recipe file, the environment fingerprint — into a single open-format archive called a nest. Later, on any machine, any cloud, any new pod, you rebuild it and check every file against its SHA-256. Same bytes or it tells you which ones differ.

Shared libraries belong to the machine, not to the nest — an archive cannot carry its operating system. That is why a nest records the image it ran on: boot the same one and they are already there. On a machine without them the rebuild still gets every byte back, and if the app then cannot start, Renest names the library that is missing and where to get it rather than leaving you to read a traceback.

It does not try to make unfamiliar things work. It reproduces what already did.

Install

uv tool install --upgrade renest
renest --version

--upgrade matters if you have installed renest before: plain uv tool install renest treats an existing install as done and leaves the old version in place, so re-running it looks like an upgrade but is not. --upgrade moves an old install to the latest and is a harmless no-op on a fresh machine.

Python 3.11 or newer. No uv on this machine yet?

curl -LsSf https://astral.sh/uv/install.sh | sh
# Windows:  powershell -c "irm https://astral.sh/uv/install.ps1 | iex"
# only have pip?  pip install uv

On a proxy network, uv and curl read the proxy only from the environment, not from the OS/system proxy settings — so export HTTPS_PROXY=http://host:port (and ALL_PROXY) first, or the very first install step hangs with no error.

That last one is safe even inside the environment you are about to capture: uv is a single binary with no dependencies of its own, so installing it moves nothing else. That is not true of installing this package with pip.

Why uv and not pip. Two reasons, and the second one matters more than taste. First, rebuilding an environment is what this tool does, and it does it by calling uv — so does the escape hatch script inside every archive. A machine without uv can install this package and still not restore anything. Second, pip install renest installs into whatever environment is active, and that is often the very environment you are about to capture; resolving our dependencies there can move versions inside it. Protecting a setup that already works is the whole point of this tool, so we do not ask you to touch it to install us. uv tool install keeps the command in its own environment. pip install renest still works if you know your environment is separate.

Use

renest pack --dir /path/to/comfyui --workflow workflow.json --out ./nests
renest verify ./nests/<id>/manifest.json --dir /path/to/comfyui
renest restore --manifest ./nests/<id>/manifest.json --dir /path/on/the/new/machine
renest doctor

In order: capture a setup that already worked, check a rebuild end to end, rebuild it somewhere else, and ask whether this machine can. --dir is always the environment root — the folder holding ComfyUI/ — and every path is one you name, never one we guess.

renest --help lists the rest (list, lint, export, serve, presign, update-rules, support).

The escape hatch

Every nest ships with restore.sh, a plain shell script that rebuilds the archive using nothing but curl, jq, sha256sum, uv and tar. It does not import a single line of the rest of this project, and it is Apache-2.0 along with the format specification. If this project disappears tomorrow, your archives still open. That is the point of it, and it is why it is licensed the way it is.

The format specification lives in specs/ inside the wheel. Anyone can write their own reader from it.

One command exists purely for that day: renest presign signs a download link for an object in your own bucket, using keys that live on your machine. The escape hatch deliberately depends on nothing but curl, jq, sha256sum, uv and tar — it has no way to sign anything itself. So if this project is gone, the machine holding your storage keys is the one that can still hand out links, and that command is how.

Versions you will see

Five separate things carry their own version, because they change at completely different speeds:

  • the tool — the version of renest itself
  • the archive format — printed by renest --version; an archive records which one it was written with, and a newer tool reads every older one in the same major version
  • the environment fingerprint — how a machine's shape is recorded
  • the retrieval grant — how a time-limited download permission is written
  • the local API — the endpoints under /api/v1 that a desktop or web client talks to

Plus a set of compatibility facts kept on your machine as data — things like which driver version a given CUDA release needs. Those are refreshed with renest update-rules without installing a new version of the tool.

Within one major version, things are added and never changed or removed. A breaking change moves to the next major version, and the old one keeps working alongside it.

Note that the tool's own version number is still 0.x, and the archive format's is not. That is deliberate, and the difference matters: the tool's command-line surface may still shift, but an archive written today stays readable. The format promise is the one your data depends on, and it does not move with the tool.

Licence — three layers, and they are not the same

Genuinely open (Apache-2.0): the archive format specification and the escape hatch script. These are the proof that you can open your own archives even if we are gone. Use, modify and redistribute them freely, with no conditions from us.

The ComfyUI plugin (GPL-3.0): it runs inside the ComfyUI process, so it follows that ecosystem's rules. It lives in its own repository.

This command-line tool — source-available, and not open-source software: the code is published in full. Read it, audit it, modify it for your own use, publish your modifications. The one thing not granted is using it, or a derivative of it, to offer other people a hosted service that competes with ours. The text is in LICENSE-CLI, which ships with this package.

It also carries a permanent exemption: any individual using it to pack, sign links for, restore or verify their own data may do so forever, unconditionally — this does not lapse because we shut down, because you have no account, or for any other reason.

In one line: the format and the escape route are public, the tool's code is open to read, and the only thing not given away is running a competing hosted service on it.

The hosted service is operated by the author of this project.

Metadata

Release files for renest 0.1.15

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for renest 0.1.15
File Size Uploaded
renest-0.1.15.tar.gz 717.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for renest 0.1.15
File Interpreter ABI Platform
renest-0.1.15-py3-none-any.whl Python 3 none any Details

Total release size: 1.3 MB

Release files / renest-0.1.15.tar.gz

Download URL renest-0.1.15.tar.gz
Size 717.4 kB
Tags Source
SHA-256 checksum
How to use checksums
4abdaa6132989a7da21d75a34a4deb6b4f18eae33729f6fad0440b1d43f3141a
BLAKE2b-256 checksum
How to use checksums
2623a216743c8b61122128e78464ab505717783b3a6bf26e66b950eae697ed86
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release files / renest-0.1.15-py3-none-any.whl

Download URL renest-0.1.15-py3-none-any.whl
Size 630.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
05457c234c7ba33013f76e651bc20192d8c847531697867e0bfae261ff2d87ea
BLAKE2b-256 checksum
How to use checksums
ccee0a879f0804aef068c3fc897dad1862d58a511a10071868112ebc3c045600
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

Release history Release notifications | RSS feed

0.1.24

2 release files

0.1.23

2 release files

0.1.22

2 release files

This release

0.1.15 This release

2 release files

0.1.14

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

0.0.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page