Skip to content

Add Octopus Deploy shell plugin - #623

Merged
scottisloud merged 2 commits into
1Password:mainfrom
xcezx:octopus-plugin
Aug 18, 2026
Merged

Add Octopus Deploy shell plugin#623
scottisloud merged 2 commits into
1Password:mainfrom
xcezx:octopus-plugin

Conversation

@xcezx

@xcezx xcezx commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Overview

Add a shell plugin for the Octopus Deploy CLI (octopus) officially provided by Octopus Deploy.

The plugin provisions OCTOPUS_API_KEY, OCTOPUS_URL, and OCTOPUS_SPACE from 1Password. It supports importing existing credentials from:

  • environment variables (OCTOPUS_API_KEY, OCTOPUS_URL, OCTOPUS_SPACE), and
  • the octopus login config file at ~/.config/octopus/cli_config.json.

It also adds a Space field name to the SDK for OCTOPUS_SPACE.

Type of change

  • Created a new plugin
  • Improved an existing plugin
  • Fixed a bug in an existing plugin
  • Improved contributor utilities or experience

Related Issue(s)

N/A

How To Test

After configuring the plugin, run a command that requires authentication, for example:

octopus space list

Tip

The guest account on the Live Demo Server officially provided by Octopus Deploy has an API Key registered with no expiration date, which can be used to verify system functionality.
OCTOPUS_URL: https://samples.octopus.app/
OCTOPUS_API_KEY: The string beginning with "API-" displayed in the "Purpose" column, which can be found by navigating to "My Profile" > "My API Keys", is available for use as API Key.

Changelog

Authenticate the Octopus Deploy CLI using Touch ID and other unlock options with 1Password Shell Plugins.

Add a shell plugin for the Octopus Deploy CLI (octopus) that provisions
OCTOPUS_API_KEY, OCTOPUS_URL, and OCTOPUS_SPACE from 1Password. Supports
importing existing credentials from environment variables and from the
octopus login config file (~/.config/octopus/cli_config.json).

Add the "Space" field name to the SDK for OCTOPUS_SPACE.
@xcezx
xcezx marked this pull request as ready for review July 7, 2026 08:01
@scottisloud
scottisloud self-requested a review July 9, 2026 19:11

@scottisloud scottisloud left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

overall looks good, and although there's a change to the SDK, it's a minor change that doesn't merit security review.

Will approve once CI fully runs, but currently not seeing the usual Github affordances to allow the full CI run. Investigating.... Sorted that out.

@scottisloud
scottisloud self-requested a review August 18, 2026 15:59

@scottisloud scottisloud left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! LGTM

@scottisloud
scottisloud merged commit 0ef2fed into 1Password:main Aug 18, 2026
3 checks passed
@scottisloud

Copy link
Copy Markdown
Contributor

Thanks for your contribution @xcezx! This will be part of a future release of the 1Password CLI. Look for it in our CLI release notes!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants