README for OctopusCmdlet

A project to re-imagine, re-design, and re-engineer 'Octopus-Cmdlets'
Explore the docs »

Report Bug · Request Feature

Table of Contents

About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Roadmap
Contributing
License
Contact
Acknowledgments

About OctopusCmdlet

Since 2007, I have done plenty of work with Octopus Deploy. Octopus-Cmdlets were interesting, but had some issues:

The Octopus Client has not been kept up to date, which has resulted in some significant drift;
Many of the Cmdlets tried to do too much;
The Cmdlets did not really leverage the PowerShell pipeline well; AND
While at least it had unit tests, I think they could be better, and segregate some tests as integration tests.

So, why not?

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

(back to top)

Getting Started

How to install OctopusCmdlet in PowerShell. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

PowerShell (minimum version 7.2)

Installation

Below is an example of how you can instruct your audience on installing and setting up this PowerShell module. These instructions do not rely on any external dependencies or services.

Install PowerShell Core of at least version 7.2 or later.
```
choco install powershell-core
```

Clone the repo

git clone https://github.com/jmcooper176/OctopusCmdlet.git

Install .NET 9.0 SDK
```
choco install dotnet-9.0-sdk
```

Setup a Local Octopus Deploy (follow the README.md at https://github.com/OctopusDeployLabs/octopus.local/blob/main/README.md)

openssl req -x509 -out octopus.crt -keyout octopus.key -newkey rsa:2048 -nodes -sha256 -subj '/CN=octopus.local' -extensions EXT -config <(printf "[dn]\nCN=octopus.local\n[req]\ndistinguished_name = dn\n[EXT]\nsubjectAltName=DNS:octopus.local\nkeyUsage=digitalSignature\nextendedKeyUsage=serverAuth")

predeploy.sh

deploy.sh

Install latest stable Pester

Install-Module -Name Pester -RequiredVersion 5.7.1

Change git remote url to avoid accidental pushes to base project

git remote set-url origin github_username/repo_name
git remote -v # confirm the changes

(back to top)

Usage

Useful examples of how OctopusCmdlet can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

Add CHANGELOG.md
Add CODEOWNERS
Add CODE_OF_CONDUCT.md
Add LICENSE.txt and Licensing headers to all source code
Add PowerShell Linter and Pester Unit Test Workflow
Add README.md
Add RELEASENOTES.txt
Add SECURITY.md
Add stand-in logo.png
Add Issue-support code
Implement all Infrastructure Cmdlets with Unit Tests (both VSTest and Pester)
Implement New-Endpoint, New-Client, New-Repository, New-Client, Find-Space, and Get-Repository with Unit Tests (both VSTest and Pester)
- Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
- Implement New-Endpoint Cmdlet
- Implement New-Repository Cmdlet
- Implement New-Client Cmdlet
- Implement Find-Space
- Implement Get-Repository
Implement Remaining Cmdlets (there will be subregions here)

ACTION
- ActionTemplate Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- ActionUpdate Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  ARTIFACTS
- Artifact Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- BuildInformation Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  AUTHORIZATION/AUTHENTICATION
- Account Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Authentication Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Certificate Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- DirectoryServices Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- ExternalSecurityGroup Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Guest Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- IDConfiguration Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Identity Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- LDAP Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Oicd Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Okta Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- OpenID Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Scoped Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- SSH Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Token Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- UsernamePassword Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  BASIC
- ApiKey Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Client Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Endpoint Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Repository Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- SystemRepository Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Space Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  BUILTIN
- BuiltInFeed Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- BuiltInPackageRepository Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  CLOUD
- AWS Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Azure Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- GCP Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Kubernetes Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  CONFIGURATION
- Archive Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Configuration Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Database Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Features Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- License Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- OfflineDrop Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Performance Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Persistence Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Proxy Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Retention Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- SMTP Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Subscription Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- SystemInfo Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  DEPLOY
- AutoDeploy Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Deploy Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  DEPLOYMENT
- Deployment Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- DeploymentAction Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- DeploymentFreeze Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- DeploymentPreview Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- DeploymentProcess Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- DeploymentSettings Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- DeploymentStep Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- DeploymentTemplate Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  FAILURE ARTIFACTS
- Defect Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Interruption Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  FEED
- Docker Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Feed Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Helm Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Maven Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- NuGet Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- OciRegistry Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Package Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  MACHINE/TARGET
- Machine/Target Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Machine/Target Policy Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Machine/Target Role Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Tentacle/Target Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Upgrade Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  MAINTENANCE
- Backup Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Maintenance Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  MISC
- DocumentType Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Execution Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Migration Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Named Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Process Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- PropertyValue Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Server Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- ServiceFabric Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- ServiceNow Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- VersioningStragegy Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- XOption Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  PROJECT
- ProjectCmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- ProjectFeed Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- ProjectGroup Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- ProjectTrigger Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  RELEASE
- Release Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- ReleaseTemplate Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  REPORT
- Report Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Summary Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  RUNBOOK
- Runbook Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- RunbookProcess Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- RunbookRun Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- RunbookSnapshot Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- RunbookTrigger Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Snapshot Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  SCHEDULE(R)/TASK
- ScheduleTask Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Scheduler Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Task Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Trigger Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  SECURITY
- Audited Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Event Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- HostProtection Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Telemetry Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  SOURCE CONTROL
- Git Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- GitHub Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  TAG
- Tag Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- TagSet Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  USER
- Invitation Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Team Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- User Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- UserInvite Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- UserPermission Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- UserRole Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- UserTeam Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  USER INTERFACE
- Dashboard Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Icon Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- WebPortal Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  VARIABLE
- LibraryVariableSet Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Variable Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- VariableSet Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  WORKER
- Worker Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- WorkerPool Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  WORK ITEM
- Jira Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
  WORKFLOW
- Channel Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Commit Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- CommunityActionTemplate Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Environment Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- LifeCycle Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Phase Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Progression Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- StepPackage Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
- Tenant Cmdlets
  - Implement VSTest and Pester Unit Tests and Integration Tests for all Cmdlets
  - Implement New- Cmdlet(s)
  - Implement Get-, Remove-, and Update- Cmdlets
  - Implement any other Cmdlets
  - Author MAML Help for each Cmdlet
Circle back and refine code, unit tests, etc.
Multi-language Support
- German

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make OctopusCmdlet better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Do not forget to give the project a star! Thanks again!

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

Top contributors:

(back to top)

License

Distributed under the BSD-3-Clause License. See LICENSE.txt for more information.

(back to top)

Contact

John Merryweather Cooper

BlueSky @jmerryweathercooper.bsky.social
LinkedIn johnmcooper8654
email jmcooper8654@gmail.com

Project Link:

https://github.com/jmcooper176/OctopusCmdlet

Clone Link:

https://github.com/jmcooper176/OctopusCmdlet.git

(back to top)

Acknowledgments

Useful resources I find helpful.

(back to top)

Name		Name	Last commit message	Last commit date
Latest commit History 35 Commits
.github		.github
.vscode		.vscode
BoundParameter.Tests		BoundParameter.Tests
NewErrorRecord.Tests		NewErrorRecord.Tests
OctopusCmdlet		OctopusCmdlet
images		images
.gitattributes		.gitattributes
.gitignore		.gitignore
Add a Common Low.csv		Add a Common Low.csv
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CmdletsToImplement.txt		CmdletsToImplement.txt
LICENSE.txt		LICENSE.txt
OctopusCmdlet.sln		OctopusCmdlet.sln
README.md		README.md
RELEASENOTES.txt		RELEASENOTES.txt
SECURITY.md		SECURITY.md

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Repository files navigation

README for OctopusCmdlet