Catesta

<p align="center"> <img src="./docs/assets/Catesta.PNG" alt="Catesta Logo" > </p>

Branch | Windows - PowerShell | Windows - pwsh | Linux | MacOS --- | --- | --- | --- | --- | main | | | | Enhancements | | | |

Synopsis

Catesta is a PowerShell module and vault project generator. It uses templates to rapidly scaffold test and build integration for a variety of CI/CD platforms.

Description

Catesta enables you to quickly scaffold a PowerShell module or Vault extension project with proper formatting, test + build automation, CI/CD integration, with just one line of code.

Features

• Quickly scaffold a new PowerShell module or SecretManagement vault project that adheres to best practices and community guidelines.
• Easily integrate your project with a variety of CI/CD platforms, including AWS, Azure, GitHub, AppVeyor, Bitbucket, and GitLab.
• Cross-platform testing to ensure functionality across different environments.
• Generate Pester tests to help you get started with unit testing.
• Automatically create a build file to analyze your code for best practices and styling, run Pester tests, create PowerShell help, and combine your functions together to build your project for publication.
• Generate resources you need to trigger CI/CD builds for your module and configure it with your preferred platform.
• Scaffold your project for hosting on your preferred platform and provide easy integration with Read the Docs for professional-looking documentation.

Getting Started

Documentation

Documentation for Catesta is available at: https://www.catesta.dev

Installation

# Install Catesta from the PowerShell Gallery
Install-Module -Name Catesta -Repository PSGallery -Scope CurrentUser

Quick start

PowerShell Module

# Scaffolds a PowerShell module project with customizable CI/CD integration options
New-ModuleProject -DestinationPath $outPutPath

SecretManagement Vault Extension Module

# Scaffolds a PowerShell SecretManagement vault project with customizable CI/CD integration options
New-VaultProject -DestinationPath $outPutPath

Contributing

If you'd like to contribute to Catesta, please see the contribution guidelines.

License

Catesta is licensed under the MIT license.