update
/octopus:update bumps the Octopus submodule in your project to the latest
available version β or to a specific version you choose β and runs
octopus setup automatically so agent configs reflect the new release
immediately.
What it solves
Keeping a submodule-based tool current by hand means checking for new releases, running the update command, and then remembering to re-run setup so the generated agent config files match the new version. Skipping the setup step leaves the old configs in place, which can cause agent behavior to diverge from the version that is actually installed.
update bundles the three steps β check, update, regenerate β into one
interactive command that shows you the version delta before committing to it.
How it works
- Run
octopus update --latestto read the current installed version and the latest available release, and present both to you. - Confirm the target version β accept the latest or specify a different one
(e.g.
v1.2.0to pin to a particular release). - Fetch and install the target version.
- Run
octopus setupautomatically to regenerate all agent configs. If no.octopus.ymlis found in the repo, setup is skipped and a warning is printed. - Report the result: current β new version, configs regenerated. Any setup warnings or errors are surfaced before the success message.
Usage & parameters
/octopus:update- (no arguments) β interactive: shows current and latest version, asks for confirmation or a specific target version, then updates and re-runs setup.
After the update, if setup reports warnings or errors, run octopus setup
manually to resolve them before using other commands.