Catesta - GitLite

KO | EN

gitlite — search

#hacktoberfest #ai #llm #go #golang #docker #macos #nodejs #windows #awesome #cli #security #openai #open-source

Catesta

(★ 197)

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.

File Explorer

Download Latest Version (.zip)

- - bug-report-or-feature-request.md
  - feature_request.md
- - wf_Linux.yml
  - wf_MacOS.yml
  - wf_Windows.yml
  - wf_Windows_Core.yml
- CODE_OF_CONDUCT.md
- CONTRIBUTING.md
- PULL_REQUEST_TEMPLATE.md
- SECURITY.md
- extensions.json
- settings.json
- tasks.json
- - Catesta.PNG
  - catesta_cicd_integrations.png
  - Catesta_favicon-32x32.png
  - CatestaIcon.png
  - powershell_secretmanagement_diagram.png
- - Catesta-AppVeyor.md
  - Catesta-AWS.md
  - Catesta-Azure.md
  - Catesta-Bitbucket.md
  - Catesta-GHActions.md
  - Catesta-GHActionsAWSCodeBuild.md
  - Catesta-GitLab.md
- Catesta-Advanced.md
- Catesta-Basics.md
- Catesta-FAQ.md
- Catesta-ModuleSchema.md
- Catesta-Vault-Extension.md
- Catesta-VaultSchema.md
- Catesta.md
- CHANGELOG.md
- index.md
- New-ModuleProject.md
- New-VaultProject.md
- requirements.txt
- - Catesta.psd1
  - Catesta.psm1
  - Imports.ps1
- Catesta.build.ps1
- Catesta.Settings.ps1
- MarkdownRepair.ps1
- PSScriptAnalyzerSettings.psd1
- module_schema_generator.ps1
- param_requirements.ps1
- vault_schema_generator.ps1
.gitignore
.readthedocs.yaml
actions_bootstrap.ps1
LICENSE
mkdocs.yml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/techthoughts2/Catesta

Downloads the entire project code from GitHub to your computer.

cd Catesta

Moves into the project folder you just downloaded.

2. Python

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.

⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.

pip install -r src/Catesta/Resources/Read_the_Docs/material/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

Runs the Python script (or module).

✅ If it runs without errors and prints output in the terminal, it worked.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Catesta

[![Minimum Supported PowerShell Version](https://img.shields.io/badge/PowerShell-5.1+-purple.svg)](https://github.com/PowerShell/PowerShell) [![PowerShell Gallery][psgallery-img]][psgallery-site] ![Cross Platform](https://img.shields.io/badge/platform-windows%20%7C%20macos%20%7C%20linux-lightgrey) [![License][license-badge]](https://raw.githubusercontent.com/techthoughts2/Catesta/main/LICENSE) [![Documentation Status](https://readthedocs.org/projects/catesta/badge/?version=latest)](https://catesta.readthedocs.io/en/latest/?badge=latest)

[psgallery-img]:   https://img.shields.io/powershellgallery/dt/Catesta?label=Powershell%20Gallery&logo=powershell
[psgallery-site]:  https://www.powershellgallery.com/packages/Catesta
[license-badge]:   https://img.shields.io/github/license/techthoughts2/Catesta

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

Branch | Windows - PowerShell | Windows - pwsh | Linux | MacOS
--- | --- | --- | --- | --- |
main | [![Catesta-Windows-PowerShell](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows.yml/badge.svg?branch=main)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows.yml) | [![Catesta-Windows-pwsh](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows_Core.yml/badge.svg?branch=main)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows_Core.yml)| [![Catesta-Linux](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Linux.yml/badge.svg?branch=main)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Linux.yml) | [![Catesta-MacOS](https://github.com/techthoughts2/Catesta/actions/workflows/wf_MacOS.yml/badge.svg?branch=main)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_MacOS.yml)
Enhancements | [![Catesta-Windows-PowerShell](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows.yml/badge.svg?branch=Enhancements)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows.yml) | [![Catesta-Windows-pwsh](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows_Core.yml/badge.svg?branch=Enhancements)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Windows_Core.yml) | [![Catesta-Linux](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Linux.yml/badge.svg?branch=Enhancements)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_Linux.yml) | [![Catesta-MacOS](https://github.com/techthoughts2/Catesta/actions/workflows/wf_MacOS.yml/badge.svg?branch=Enhancements)](https://github.com/techthoughts2/Catesta/actions/workflows/wf_MacOS.yml)

## 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](https://docs.microsoft.com/powershell/scripting/developer/module/how-to-write-a-powershell-script-module?view=powershell-7) or [Vault extension](https://github.com/PowerShell/SecretManagement) 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](https://github.com/pester/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](https://www.catesta.dev)

### Installation

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

### Quick start

### PowerShell Module

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

### SecretManagement Vault Extension Module

```powershell
# 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](.github/CONTRIBUTING.md).

## License

Catesta is licensed under the [MIT license](LICENSE).