Skip to content
PuniDocs
Open Puni

Checkpoint commands


Keep and restore a scene file with its assets and checksums.

Local checkpoints are files you name. Read Versions and checkpoints for the library's own.

puni checkpointKeep and restore a scene file with its assets and checksums.

CommandWhat it does
puni checkpoint createWrite a named checkpoint of a local scene.
puni checkpoint restoreValidate a checkpoint's document and assets, then write it as the scene.

#checkpoint create

Write a named checkpoint of a local scene.

puni checkpoint create --file scene.json --name Before --output before.json

FlagTypeDefaultValuesWhat it does
--file requiredstringThe scene document or portable file to read. `-` reads it from standard input.
--name requiredstringThe checkpoint's name.
--output requiredstringWhere to write the checkpoint.
--revisionnumberA known remote revision to record with it.
--asset-rootstringA directory mirroring the scene's asset URIs, for a bare document whose assets live on disk.
--overwritebooleanfalseReplace the output file if it already exists.
--jsonbooleanfalseAnswer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope.
--help -hbooleanPrint the command list.

#Run checkpoint create

bash
puni checkpoint create --file scene.json --name 'Before colour' --output before.json --json

#checkpoint restore

Validate a checkpoint's document and assets, then write it as the scene.

puni checkpoint restore --file before.json --output scene.json --overwrite

FlagTypeDefaultValuesWhat it does
--file requiredstringThe checkpoint to restore.
--output requiredstringWhere to write the scene.
--overwritebooleanfalseReplace the output file if it already exists.
--jsonbooleanfalseAnswer with one JSON envelope instead of the shell view. Exception: agent serve streams raw lifecycle JSON lines before its final envelope.
--help -hbooleanPrint the command list.

#Run checkpoint restore

bash
puni checkpoint restore --file before.json --output scene.json --overwrite --json

Back to the command line index for every group.

Was this useful?