mirror of https://github.com/GoodOlClint/PSProxmoxVE.git synced 2026-07-26 07:58:14 +00:00

Files

T

Clint Branham b4754c72a0 docs: update README, CHANGELOG, SECURITY.md, and review artifacts

- README: move Set-PveStorage to Storage section, Set-PveApiToken to
  Access section (were miscategorized under "Access — Groups & Domains")
- CHANGELOG: add Changed section with 13 architectural improvements,
  expand Fixed section with all ConfirmImpact and credential fixes
- SECURITY.md: add SecureString detail, Input Validation section,
  Dependabot mention, SkipCertificateCheck warning note
- CLAUDE.md: update review system reference to scan-7
- findings.json: F050 resolved (URL encoding), F031 resolved (credentials)
- REVIEW_REPORT.md: scan-7 report

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

2026-03-23 17:41:19 -05:00

2.4 KiB

Raw Blame History

PSProxmoxVE — Claude Code Instructions

Project Overview

C# binary PowerShell module for managing Proxmox VE (PVE) infrastructure. Two projects:

src/PSProxmoxVE/ — Cmdlets and module surface (targets netstandard2.0)
src/PSProxmoxVE.Core/ — Services, models, HTTP client (targets netstandard2.0)

Tests: xUnit (tests/PSProxmoxVE.Core.Tests/) and Pester 5 (tests/PSProxmoxVE.Tests/).

Build & Test

# Build
dotnet build PSProxmoxVE.sln

# xUnit tests
dotnet test tests/PSProxmoxVE.Core.Tests/

# Pester tests (requires pwsh)
pwsh -Command "Invoke-Pester tests/PSProxmoxVE.Tests/ -Output Detailed"

# Run all tests via helper
pwsh -File tools/Invoke-Tests.ps1

Key Conventions

All cmdlets use Pve noun prefix
All cmdlet classes must be sealed
All cmdlets must have [OutputType] attribute
Destructive cmdlets must set ConfirmImpact = ConfirmImpact.High
VmId parameters: [ValidateRange(100, 999999999)], nullable when optional
JSON: Newtonsoft.Json only ([JsonProperty]), no System.Text.Json attributes
Task polling: always use TaskService.WaitForTask, never inline loops
Passwords: SecureString type, never plain string
URL paths: Uri.EscapeDataString() on all dynamic path segments
No bare catch {} blocks — use specific or filtered exceptions
Verb class constants required (VerbsCommon.Get, not "Get")

Review System

This repo uses a structured review system to track findings and prevent regressions.

Key files

docs/review/findings.json — stable findings database. IDs are permanent (F001, F002...). Never renumber. Read this before any coding session to understand open issues.
docs/review/REVIEW_REPORT.md — latest full review report (scan-7, 2026-03-23)
DECISIONS.md — architectural decisions and anti-patterns. Read this before writing any new code. It documents patterns that were deliberately chosen or changed and must not be reintroduced.

Before starting a coding session

Read DECISIONS.md to understand established patterns
Check docs/review/findings.json for open findings relevant to the area you're working in
Do not introduce patterns listed as anti-patterns in DECISIONS.md

Finding ID stability

Finding IDs (F001, F002...) are permanent. A resolved finding is never deleted from findings.json — it is marked resolved with evidence of the fix. If a finding reappears, it is marked regressed and retains its original ID.

2.4 KiB Raw Blame History