Skip to content

update go-cli docs #3437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
team-miscellaneous-branch-protections merged 1 commit into from
Sep 1, 2026
Merged

update go-cli docs #3437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/pages/docs/cli/_generated/octopus-release-deploy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-08-25
modDate: 2026-09-01
title: octopus release deploy
description: Deploy releases
navOrder: 123
Expand Down Expand Up @@ -30,6 +30,8 @@ Flags:
--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)
--specific-target-tag stringArray Deploy to targets matching this tag (can be specified multiple times)
--excluded-target-tag stringArray Deploy to targets except for those matching this tag (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

Expand Down
56 changes: 29 additions & 27 deletions src/pages/docs/cli/_generated/octopus-runbook-run.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: src/layouts/Cli.astro
pubDate: 2023-01-01
modDate: 2026-08-25
modDate: 2026-09-01
title: octopus runbook run
description: Run runbooks in Octopus Deploy
navOrder: 131
Expand All @@ -15,32 +15,34 @@ Usage:
octopus runbook run [flags]

Flags:
-p, --project string Name or ID of the project to run the runbook from
-n, --name string Name of the runbook to run
--runbook-tag stringArray Run all runbooks matching this tag (can be specified multiple times). Format is 'Tag Set Name/Tag Name'. Mutually exclusive with --name.
-e, --environment stringArray Run in this environment (can be specified multiple times)
--tenant stringArray Run for this tenant (can be specified multiple times)
--tenant-tag stringArray Run for tenants matching this tag (can be specified multiple times). Format is 'Tag Set Name/Tag Name', such as 'Regions/South'.
--run-at string Run at a later time. Run now if omitted. TODO date formats and timezones!
--run-at-expiry string Cancel a scheduled run if it hasn't started within this time period.
-v, --variable stringArray Set the value for a prompted variable in the format Label:Value
--snapshot string Name or ID of the snapshot to run. If not supplied, the command will attempt to use the published snapshot.
--skip stringArray Exclude specific steps from the runbook
--guided-failure string Enable Guided failure mode (true/false/default)
--priority string Jump the task queue ahead of other queued tasks (true/false/default). Requires the Priority Tasks feature. For runbook runs, 'default' is the same as 'false'.
--force-package-download Force re-download of packages
--run-target stringArray Run on this target (can be specified multiple times)
--exclude-run-target stringArray Run on targets except for this (can be specified multiple times)
--git-ref string Git Reference e.g. refs/heads/main. Only relevant for config-as-code projects where runbooks are stored in Git.
--package-version string Default version to use for all packages. Only relevant for config-as-code projects where runbooks are stored in Git.
--package stringArray Version specification for a specific package.
Format as {package}:{version}, {step}:{version} or {package-ref-name}:{packageOrStep}:{version}
You may specify this multiple times.
Only relevant for config-as-code projects where runbooks are stored in Git.
--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.
-p, --project string Name or ID of the project to run the runbook from
-n, --name string Name of the runbook to run
--runbook-tag stringArray Run all runbooks matching this tag (can be specified multiple times). Format is 'Tag Set Name/Tag Name'. Mutually exclusive with --name.
-e, --environment stringArray Run in this environment (can be specified multiple times)
--tenant stringArray Run for this tenant (can be specified multiple times)
--tenant-tag stringArray Run for tenants matching this tag (can be specified multiple times). Format is 'Tag Set Name/Tag Name', such as 'Regions/South'.
--run-at string Run at a later time. Run now if omitted. TODO date formats and timezones!
--run-at-expiry string Cancel a scheduled run if it hasn't started within this time period.
-v, --variable stringArray Set the value for a prompted variable in the format Label:Value
--snapshot string Name or ID of the snapshot to run. If not supplied, the command will attempt to use the published snapshot.
--skip stringArray Exclude specific steps from the runbook
--guided-failure string Enable Guided failure mode (true/false/default)
--priority string Jump the task queue ahead of other queued tasks (true/false/default). Requires the Priority Tasks feature. For runbook runs, 'default' is the same as 'false'.
--force-package-download Force re-download of packages
--run-target stringArray Run on this target (can be specified multiple times)
--exclude-run-target stringArray Run on targets except for this (can be specified multiple times)
--specific-target-tag stringArray Run on targets matching this tag (can be specified multiple times)
--excluded-target-tag stringArray Run on targets except for those matching this tag (can be specified multiple times)
--git-ref string Git Reference e.g. refs/heads/main. Only relevant for config-as-code projects where runbooks are stored in Git.
--package-version string Default version to use for all packages. Only relevant for config-as-code projects where runbooks are stored in Git.
--package stringArray Version specification for a specific package.
Format as {package}:{version}, {step}:{version} or {package-ref-name}:{packageOrStep}:{version}
You may specify this multiple times.
Only relevant for config-as-code projects where runbooks are stored in Git.
--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.


Global Flags:
Expand Down