Hello! Thanks for visiting! mirrorctl is still a young project, and the documentation is still a work-in-progress.
snapshot create

snapshot create

The mirrorctl snapshot create command creates a new hardlink-based snapshot of a mirror.

It’s a fundatmental part of maintain multiple versions of a respository.

mirrorctl snapshot create <mirror-id> [snapshot-name] [flags]

Usage

Create a snapshot with an auto-generated name:

mirrorctl snapshot create debian-trixie

Create a snapshot with a custom name:

mirrorctl snapshot create debian-trixie "2025-10-09-stable"

Create a snapshot and immediately publish it to staging:

mirrorctl snapshot create debian-trixie --stage

Overwrite an existing snapshot:

mirrorctl snapshot create debian "backup" --force

Arguments

Argument Required Description
mirror-id Yes The ID of the mirror to check.
The mirror ID must match a key defined in the [mirrors] section of your configuration file.
snapshot-name No Optional name for the snapshot.
If not provided, a timestamp-based name will be auto-generated according to the mirror’s snapshot configuration.

Flags

Flag Default Usage
--config, -c /etc/mirrorctl/mirror.toml Path to the configuration file.
--force false Overwrite existing snapshot with the same name.
--stage false Publish the snapshot to staging after creation.
--verbose-errors false Show detailed error information including stack traces.

Exit Status

The command exits with status 0 on success and 1 on error.

See Also