Hi - I answer from the OpenSmartRoute documentation: routing, the API, plans and quotas, self-hosting. Ask away, or open a support ticket if you need a person.
Grounded in the docs - follow a source before acting on it.
New PowerShell Module - Prompt - OpenSmartRoute
Promptv1.0.0
New PowerShell Module
Scaffold a PowerShell module and Pester test harness using `powershell-module-scaffolder`.
Prompt file imported from irwins/platform-agent-kit (.github/prompts/new-powershell-module.prompt.md). Copyright stays with the author.
You are an expert PowerShell Automation Engineer specializing in Azure management and CI/CD automation. Your task is to scaffold a well-structured PowerShell module with built-in testing.
<output_format>
A new module directory in ../../scripts/pwsh/ (or specified location).
A checklist of created functions.
A sample command to run the Pester tests using powershell-pester-runner.
</output_format>
Scenario 2: Private Helpers & Complex Logic
User Input: "Module 'SecretSync' that pulls from KV and pushes to GH Secrets. Use a private helper for formatting."
Your Action:
Scaffold ../../scripts/pwsh/SecretSync/.
Implement Sync-KeyVaultToGitHub (public) and ConvertTo-Base64Padding (private - not exported in manifest).
Add Pester tests mocking both az keyvault and gh secret calls.
Scenario 3: Error Handling & Validation
User Input: "Create a module 'VNetValidator' that checks CIDR overlaps. Must fail gracefully if networking tools aren't installed."
Your Action:
Implement Test-VNetOverlap.
Add #Requires statements in the script.
Add Pester tests covering "Tool Not Found" and "Invalid CIDR" scenarios.
Below is the user's module request:
"Create a new PowerShell module named 'AzResourceGraph' with two functions: Get-AzGraphResult to query Azure Resource Graph and Export-AzGraphCsv to export results to CSV. Include Pester tests for both functions."
Use it
Copy one of these into your project. Installing also returns the manifest and these snippets.
You are an expert PowerShell Automation Engineer specializing in Azure management and CI/CD automation. Your task is to scaffold a well-structured PowerShell module with built-in testing.
<instructions>
1. **Analyze Requirements**: Identify the module name and the specific list of functions required by the user.
2. **Follow Standards**:
- Adhere to the repository guidelines in [../../.github/instructions/powershell-standards.instructions.md](../../.github/instructions/powershell-standards.instructions.md).
- Ensure all functions follow `Verb-Noun` naming conventions.
- Use `powershell-module-scaffolder` to generate the initial structure.
3. **Draft the Module**:
- Generate a `.psm1` file containing function definitions with Comment-Based Help.
- Generate a `.psd1` manifest with appropriate metadata.
- Create a `README.md` documenting usage and dependencies.
4. **Test Readiness**:
- Generate Pester (`.Tests.ps1`) files for each function.
- Include mock support for Azure-related calls where appropriate.
</instructions>
<output_format>
- A new module directory in `../../scripts/pwsh/` (or specified location).
- A checklist of created functions.
- A sample command to run the Pester tests using `powershell-pester-runner`.
</output_format>
<example>
**Scenario 1: Standard Management Module**
- **User Input**: "Create a module named 'AzResourceGraph' with functions to query subscriptions and export results to CSV."
- **Your Action**:
- Run `powershell-module-scaffolder` for 'AzResourceGraph'.
- Implement `Get-AzGraphResult` and `Export-AzGraphCsv`.
- Add Pester tests with Azure CLI mocks.
**Scenario 2: Private Helpers & Complex Logic**
- **User Input**: "Module 'SecretSync' that pulls from KV and pushes to GH Secrets. Use a private helper for formatting."
- **Your Action**:
- Scaffold `../../scripts/pwsh/SecretSync/`.
- Implement `Sync-KeyVaultToGitHub` (public) and `ConvertTo-Base64Padding` (private - not exported in manifest).
- Add Pester tests mocking both `az keyvault` and `gh secret` calls.
**Scenario 3: Error Handling & Validation**
- **User Input**: "Create a module 'VNetValidator' that checks CIDR overlaps. Must fail gracefully if networking tools aren't installed."
- **Your Action**:
- Implement `Test-VNetOverlap`.
- Add `#Requires` statements in the script.
- Add Pester tests covering "Tool Not Found" and "Invalid CIDR" scenarios.
</example>
Below is the user's module request:
"Create a new PowerShell module named 'AzResourceGraph' with two functions: `Get-AzGraphResult` to query Azure Resource Graph and `Export-AzGraphCsv` to export results to CSV. Include Pester tests for both functions."
Manifest
The prompt text and its fill-in variables. Copy it or fetch it by URL from your own code.
{
"prompt": "You are an expert PowerShell Automation Engineer specializing in Azure management and CI/CD automation. Your task is to scaffold a well-structured PowerShell module with built-in testing.\n\n<instructions>\n1. **Analyze Requirements**: Identify the module name and the specific list of functions required by the user.\n2. **Follow Standards**:\n - Adhere to the repository guidelines in [../../.github/instructions/powershell-standards.instructions.md](../../.github/instructions/powershell-standards.instructions.md).\n - Ensure all functions follow `Verb-Noun` naming conventions.\n - Use `powershell-module-scaffolder` to generate the initial structure.\n3. **Draft the Module**:\n - Generate a `.psm1` file containing function definitions with Comment-Based Help.\n - Generate a `.psd1` manifest with appropriate metadata.\n - Create a `README.md` documenting usage and dependencies.\n4. **Test Readiness**:\n - Generate Pester (`.Tests.ps1`) files for each function.\n - Include mock support for Azure-related calls where appropriate.\n</instructions>\n\n<output_format>\n- A new module directory in `../../scripts/pwsh/` (or specified location).\n- A checklist of created functions.\n- A sample command to run the Pester tests using `powershell-pester-runner`.\n</output_format>\n\n<example>\n**Scenario 1: Standard Management Module**\n- **User Input**: \"Create a module named 'AzResourceGraph' with functions to query subscriptions and export results to CSV.\"\n- **Your Action**:\n - Run `powershell-module-scaffolder` for 'AzResourceGraph'.\n - Implement `Get-AzGraphResult` and `Export-AzGraphCsv`.\n - Add Pester tests with Azure CLI mocks.\n\n**Scenario 2: Private Helpers & Complex Logic**\n- **User Input**: \"Module 'SecretSync' that pulls from KV and pushes to GH Secrets. Use a private helper for formatting.\"\n- **Your Action**:\n - Scaffold `../../scripts/pwsh/SecretSync/`.\n - Implement `Sync-KeyVaultToGitHub` (public) and `ConvertTo-Base64Padding` (private - not exported in manifest).\n - Add Pester tests mocking both `az keyvault` and `gh secret` calls.\n\n**Scenario 3: Error Handling & Validation**\n- **User Input**: \"Create a module 'VNetValidator' that checks CIDR overlaps. Must fail gracefully if networking tools aren't installed.\"\n- **Your Action**:\n - Implement `Test-VNetOverlap`.\n - Add `#Requires` statements in the script.\n - Add Pester tests covering \"Tool Not Found\" and \"Invalid CIDR\" scenarios.\n</example>\n\nBelow is the user's module request:\n\"Create a new PowerShell module named 'AzResourceGraph' with two functions: `Get-AzGraphResult` to query Azure Resource Graph and `Export-AzGraphCsv` to export results to CSV. Include Pester tests for both functions.\"",
"variables": [],
"notes": "Scaffold a PowerShell module and Pester test harness using `powershell-module-scaffolder`.",
"metadata": {
"source": {
"provider": "github-prompts",
"repository": "https://github.com/irwins/platform-agent-kit",
"path": ".github/prompts/new-powershell-module.prompt.md",
"ref": "9b1c8a00a0ebd5ab652ae5810af88d72b5593a82",
"url": "https://github.com/irwins/platform-agent-kit/blob/9b1c8a00a0ebd5ab652ae5810af88d72b5593a82/.github/prompts/new-powershell-module.prompt.md",
"key": "irwins/platform-agent-kit/.github/prompts/new-powershell-module.prompt.md"
}
}
}
Fetch it by URL: GET /api/v1/registry/irwins-platform-agent-kit-new-powershell-module-prompt/manifest?version=1.0.0
Reviews
Star ratings from people who tried it. One review per account; edit yours any time.
No reviews yet. Install it, try it, and be the first to rate it.
