Search
Blog posts
Command-line tab completion for Octopus CLI
Enable tab completion for the Octopus CLI today! We'll also dive into how shell completion works in some popular shell environments.Outage on octopus.com - report and learnings
Public incident report and our learnings about the octopus.com DNS disruption from January 25 – 26, 2023.
Loading...
Documentation
Install autocomplete
Install a shell auto-complete script into your shell profile, if they aren't already there. Supports pwsh, zsh, bash & powershell.Updating Linux
With Octopus Deploy you can update and patch Linux machines with a runbook as part of a routine operations task.Working with Spaces
How to work with Spaces in the Octopus.Client library.Working directly with the Client
How to use the IOctopusClient type in the Octopus.Client library.Delete a Space
An example script to delete a space.Output variables
Output variables allow you to set dynamic variables in one step that can be used in subsequent steps.How to regenerate certificates with Octopus Server and Tentacle
How to regenerate the certificates used for communication between Octopus Server and its Tentacles.Error handling
Error handling for scripts in Octopus.Logging messages from scripts
When your scripts emit messages Octopus will display the messages in the Task Logs at the most appropriate level for the message.Output variables
Your scripts can emit variables that are available in subsequent deployment steps.Using variables in scripts
With Octopus you can define variables for use with your custom scripts.Artifacts
Artifacts in Octopus provide a convenient way to collect files from remote machines during deployments.New Octopus Target Command
Function for creating an Octopus target for a step packageUpdate variable set variable value
An example script that loads variables from a variable set, looks for a match and replaces the variable value.Create a new scheduled runbook trigger
An example script to create and publish a new runbook scheduled triggerBulk add a project to a list of tenants
An example script that will add a project to a lot of tenants at once.Enable/disable project
An example script that enables or disables a project in Octopus.Create a Google Cloud account
An example script to create a Google Cloud (GCP) account in Octopus.SSH key pair account
SSH key pair accounts allow you to securely authenticate with SSH targets.Download Deployment Artifact
An example script to download a deployment artifact to a specified location.Download Runbook Artifact
An example script to download a runbook artifact to a specified location.Reference files within a package
How to reference files within a package.Define and use variables
Step by step guide on how to define and use variables in an Octopus Deploy deployment.Runbook specific variables
Step by step guide on how to define and use variables in an Octopus Deploy runbook.Adding Environments
An example script to create environments in a Space.Defining the runbook process for workers
Step by step guide on how to define a runbook process to run on Workers in Octopus Deploy.Defining the runbook process for targets
Step by step guide on how to define a runbook process in Octopus Deploy.Find unused projects
An example script that will find any project that hasn't had a release created in the previous daysCan't find what you are looking for? You can also search our support forum.