﻿# octopus release deploy

Deploy releases in Octopus Deploy

```text
Usage:
  octopus release deploy [flags]

Flags:
  -p, --project string                             Name or ID of the project to deploy the release from
      --version string                             Release version to deploy
  -e, --environment stringArray                    Deploy to this environment (can be specified multiple times)
      --tenant stringArray                         Deploy to this tenant (can be specified multiple times)
      --tenant-tag stringArray                     Deploy to tenants matching this tag (can be specified multiple times). Format is 'Tag Set Name/Tag Name', such as 'Regions/South'.
      --deploy-at string                           Deploy at a later time. Deploy now if omitted. TODO date formats and timezones!
      --deploy-at-expiry string                    Cancel the deployment if it hasn't started within this time period.
  -v, --variable stringArray                       Set the value for a prompted variable in the format Label:Value
      --update-variables                           Overwrite the release variable snapshot by re-importing variables from the project.
      --skip stringArray                           Exclude specific steps from the deployment
      --guided-failure string                      Enable Guided failure mode (true/false/default)
      --force-package-download                     Force re-download of packages
      --deployment-target stringArray              Deploy to this target (can be specified multiple times)
      --exclude-deployment-target stringArray      Deploy to targets except for this (can be specified multiple times)
      --deployment-freeze-name stringArray         Override this deployment freeze (can be specified multiple times)
      --deployment-freeze-override-reason string   Reason for overriding a deployment freeze

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

:::div{.success}
**Octopus Samples instance**

Many of the examples we use, reference the [samples instance](https://samples.octopus.app/app#/users/sign-in) of Octopus Deploy. If you'd like to explore the samples instance, you can log in as a guest.
:::

```bash
octopus release deploy  # fully interactive
octopus release deploy --project MyProject --version 1.0 --environment Dev
octopus release deploy --project MyProject --version 1.0 --tenant-tag Regions/East --tenant-tag Regions/South
octopus release deploy -p MyProject --version 1.0 -e Dev --skip InstallStep --variable VarName:VarValue
octopus release deploy -p MyProject --version 1.0 -e Dev --force-package-download --guided-failure true -f basic

```

## Learn more

- [Octopus CLI](/docs/octopus-rest-api/cli)
- [Creating API keys](/docs/octopus-rest-api/how-to-create-an-api-key)
