This reference is generated from the comment-based help on the public PowerShell functions.
| Cmdlet | CLI command(s) | Purpose |
|---|---|---|
| Export-AvmReadmeNote | avm docs export-notes |
Extract authored Bicep README Notes into an adjacent, tracked sidecar. |
| Get-AvmAuthoringPlaceholder | Returns a placeholder message confirming the Avm.Authoring module is installed. | |
| Get-AvmBicepAzureDependency | List Azure PowerShell dependencies required for Bicep deployment tests. | |
| Get-AvmBicepE2eDeploymentMatrix | Build native Bicep E2E deployment selections without Azure access. | |
| Get-AvmBicepE2eTestContext | Revalidate one selected Bicep E2E case and return its execution context. | |
| Get-AvmBicepPendingReleasePlan | Discover versioned Bicep modules awaiting release tags. | |
| Get-AvmBicepWorkflowModuleMatrix | Build a deterministic Bicep module workflow matrix. | |
| Get-AvmBicepWorkflowTestFiles | Discover native Bicep test files and policy candidates for one module. | |
| Get-AvmCatalogTelemetryPrefix | Read current and historical telemetry prefixes from the public AVM catalog. | |
| Get-AvmModuleContext | avm context |
Classify a directory as a Bicep or Terraform module/monorepo context. |
| Get-AvmModuleMetadata | avm metadata show |
Read and validate an existing module metadata.json file. |
| Get-AvmTool | avm tool listavm tool which |
List or query managed tools from the avm.pins manifest. |
| Get-AvmVersion | avm version |
Reports the running Avm.Authoring module version and host runtime. |
| Initialize-AvmBicepReleaseMatrix | Build a guarded top-level Bicep release matrix. | |
| Initialize-AvmBicepWorkflowMatrix | Discover a checked-out Bicep workflow matrix for a push, pull request, or manual run. | |
| Initialize-AvmModule | avm init |
Initialize a Bicep module locally, or create and set up a Terraform module repository. |
| Initialize-AvmModuleMetadata | avm metadata initialize |
Create metadata.json without overwriting an existing file. |
| Install-AvmTool | avm tool install |
Install one, several, or all managed tools from avm.pins. |
| Invoke-Avm | avm |
Avm CLI dispatcher. The 'avm' alias is the user-facing entry point. |
| Invoke-AvmCheckConvention | avm check convention |
Run convention checks against the resolved module. |
| Invoke-AvmCheckPolicy | avm check policy |
Run policy checks against the resolved module. |
| Invoke-AvmDocs | avm docs |
Generate or refresh module documentation under $Path. |
| Invoke-AvmDoctor | avm doctor |
Diagnoses the local environment for running Avm.Authoring. |
| Invoke-AvmFormat | avm format |
Format all source files in the resolved module under $Path. |
| Invoke-AvmLint | avm lint |
Lint all source files in the resolved module under $Path. |
| Invoke-AvmPrCheck | avm pr-check |
Run the pull-request linting and drift gauntlet against the resolved module: metadata -> initialize (Terraform) -> sync -> format -> transform -> lint -> check policy -> check convention -> validate -> docs. |
| Invoke-AvmPreCommit | avm pre-commit |
Run the standard pre-commit gauntlet against the resolved module: bicep: metadata -> format -> lint -> validate -> transform -> docs. terraform: metadata -> initialize -> sync -> check convention -> transform -> format -> docs. |
| Invoke-AvmSync | avm sync |
Synchronise the current Terraform module repository's managed files against the AVM governance source-of-truth (file sync only, no PR). |
| Invoke-AvmTest | avm test |
Build Bicep sources or validate Terraform examples under $Path. |
| Invoke-AvmTestCleanup | avm test cleanup |
Resume Bicep test cleanup from its saved JSON state. |
| Invoke-AvmTestE2e | avm test e2e |
Run Bicep or Terraform deployment tests with ordinary cleanup. |
| Invoke-AvmTestIntegration | avm test integration |
Run Bicep ARM validation/what-if or Terraform integration tests. |
| Invoke-AvmTestUnit | avm test unit |
Run the module's Bicep Pester or Terraform unit-test tier. |
| Invoke-AvmTransform | avm transform |
Transform the module's authored source into governed artifacts. |
| New-AvmTelemetryIdPrefix | Generate a seven-character hexadecimal telemetry identifier. | |
| Register-AvmFeature | avm register-features |
Ensure features declared at a module root are registered in one Azure test subscription. |
| Select-AvmTestSubscription | Select a Bicep test subscription using the repository's exact reservation map. | |
| Set-AvmBicepReleaseTags | Create guarded Bicep module release tags from a checked-out target. | |
| Test-AvmModuleMetadata | avm metadata validate |
Validate existing or supplied module metadata with packaged Pester tests. |
| Update-AvmAuthoring | avm upgrade |
Update Avm.Authoring using the configured PowerShell repositories. |