---
name: "singularity-checkpoint-instance"
section: "1"
platform: "linux"
package: "apptainer"
version: "1.5.4-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/singularity-checkpoint-instance"
---

# singularity-checkpoint-instance(1)

Checkpoint the state of a running instance (experimental)

## NAME

apptainer-checkpoint-instance - Checkpoint the state of a running instance (experimental)

## SYNOPSIS

**apptainer checkpoint instance**

## DESCRIPTION

The checkpoint instance command checkpoints an active instance by name. The instance must\
   have been started with either --dmtcp-launch or --dmtcp-restart.

## OPTIONS

**-h**, **--help**\[=false\]\
 	help for instance

**-H**, **--home**="/build"\
 	a home directory specification.  spec can either be a src path or src:dest pair.  src is the source path of the home directory outside the container and dest overrides the home directory within the container.

## EXAMPLE

```
  To checkpoint an instance:
  $ apptainer checkpoint instance example-instance
```

## SEE ALSO

**[apptainer-checkpoint(1)](/apptainer-checkpoint/1.md)**

## HISTORY

22-Sep-2026 Auto generated by spf13/cobra