octopus runbook snapshot create

Create a runbook snapshot in Octopus Deploy

Usage:
  octopus runbook snapshot create [flags]

Aliases:
  create, new

Flags:
      --git-resource stringArray     Git reference for a specific Git resource.
                                     Format as {step}:{git-ref}, {step}:{git-resource-name}:{git-ref}
                                     You may specify this multiple times.
                                     Only relevant for config-as-code projects where runbooks are stored in Git.
  -n, --name string                  Override the snapshot name
      --package stringArray          Version specification a specific packages.
                                     Format as {package}:{version}, {step}:{version} or {package-ref-name}:{packageOrStep}:{version}
                                     You may specify this multiple times
      --package-version string       Default version to use for all packages. Only relevant for config-as-code projects where runbooks are stored in Git.
  -p, --project string               Name or ID of the project where the runbook is
      --publish                      Publish the snapshot immediately
  -r, --runbook string               Name or ID of the runbook to create the snapshot for
      --snapshot-notes string        Release notes to attach
      --snapshot-notes-file string   Release notes to attach (from file)


Global Flags:
  -h, --help                   Show help for a command
      --no-prompt              Disable prompting in interactive mode
  -f, --output-format string   Specify the output format for a command ("json", "table", or "basic") (default "table")
  -s, --space string           Specify the space for operations

Examples

Octopus Samples instance

Many of the examples we use, reference the samples instance of Octopus Deploy. If you’d like to explore the samples instance, you can log in as a guest.

$ octopus runbook snapshot create --project MyProject --runbook "Rebuild DB Indexes"
$ octopus runbook snapshot create --project MyProject --runbook "Rebuild DB Indexes" --name "My cool snapshot"
$ octopus runbook snapshot create -p MyProject -r "Restart App" --package "azure-cli:1.2.3" --no-prompt
$ octopus runbook snapshot create -p MyProject -r "Restart App" --git-resource "Script step from Git:refs/heads/dev-branch" --publish --no-prompt

Learn more

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Wednesday, May 7, 2025

Edit on GitHub