Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PSBicep/PSBicep
This is the repo for the Bicep PowerShell Module.
https://github.com/PSBicep/PSBicep
arm arm-templates azure bicep bicep-azure bicep-cli bicep-lang bicep-powershell powershell powershell-module
Last synced: about 1 month ago
JSON representation
This is the repo for the Bicep PowerShell Module.
- Host: GitHub
- URL: https://github.com/PSBicep/PSBicep
- Owner: PSBicep
- License: mit
- Created: 2021-01-12T13:17:08.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-12T16:01:04.000Z (about 1 month ago)
- Last Synced: 2024-11-12T17:18:07.158Z (about 1 month ago)
- Topics: arm, arm-templates, azure, bicep, bicep-azure, bicep-cli, bicep-lang, bicep-powershell, powershell, powershell-module
- Language: PowerShell
- Homepage:
- Size: 831 KB
- Stars: 134
- Watchers: 9
- Forks: 38
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- AWESOME-Azure-Bicep - PSBicep - Bicep PowerShell Module
README
# ![BicepIcon] PSBicep - Bicep PowerShell Module
[![Bicep]][BicepGallery] [![BicepPreview]][BicepGalleryPreview] [![BicepDownloads]][BicepGallery]
This is the repository for the Bicep PowerShell Module. This is a community project created to enable the features provided by the [Bicep CLI](https://github.com/Azure/bicep) in PowerShell. The module provides the same functionality as Bicep CLI, plus some additional features to simplify the Bicep authoring experience.
Commands implemented:
- [Build-Bicep](./Docs/Help/Build-Bicep.md)
- [Clear-BicepModuleCache](./Docs/Help/Clear-BicepModuleCache.md)
- [Convert-BicepParamsToDecoratorStyle](./Docs/Help/Convert-BicepParamsToDecoratorStyle.md)
- [Convert-JsonToBicep](./Docs/Help/Convert-JsonToBicep.md)
- [ConvertTo-Bicep](./Docs/Help/ConvertTo-Bicep.md)
- [Find-BicepModule](./Docs/Help/Find-BicepModule.md)
- [Get-BicepApiReference](./Docs/Help/Get-BicepApiReference.md)
- [Get-BicepConfig](./Docs/Help/Get-BicepConfig.md)
- [Get-BicepMetadata](./Docs/Help/Get-BicepMetadata.md)
- [Get-BicepUsedModules](./Docs/Help/Get-BicepUsedModules.md)
- [Get-BicepVersion](./Docs/Help/Get-BicepVersion.md)
- [Get-UsedModulesInBicepFile](./Docs/Help/Get-UsedModulesInBicepFile.md)
- [Install-BicepCLI](./Docs/Help/Install-BicepCLI.md)
- [New-BicepMarkdownDocumentation](./Docs/Help/New-BicepMarkdownDocumentation.md)
- [New-BicepParameterFile](./Docs/Help/New-BicepParameterFile.md)
- [Publish-Bicep](./Docs/Help/Publish-Bicep.md)
- [Restore-Bicep](./Docs/Help/Restore-Bicep.md)
- [Test-BicepFile](./Docs/Help/Test-BicepFile.md)
- [Uninstall-BicepCLI](./Docs/Help/Uninstall-BicepCLI.md)
- [Update-BicepCLI](./Docs/Help/Update-BicepCLI.md)
- [Update-BicepParameterFile](./Docs/Help/Update-BicepParameterFile.md)
- [Update-BicepTypes](./Docs/Help/Update-BicepTypes.md)
- [Build-BicepParam](./Docs/Help/Build-BicepParam.md)
- [Export-BicepResource](./Docs/Help/Export-BicepResource.md)
- [Export-BicepChildResource](./Docs/Help/Export-BicepChildResource.md)
- [Format-BicepFile](./Docs/Help/Format-BicepFile.md)
>**Note:** Starting with version `1.3.0` of the Bicep PowerShell module the cmdlets `Build-Bicep` and `ConvertTo-Bicep` uses the assemblies from the official [Bicep](https://github.com/Azure/bicep) repository instead of wrapping the Bicep CLI. When new Bicep versions are released there will be a slight delay before the PowerShell module gets tested updated with the latest assemblies. If new functionality is added to Bicep CLI before the PowerShell module supports it, use `Install-BicepCLI` to install the latest Bicep CLI version and use the CLI while waiting for an updated PowerShell module.
>**UPCOMING BREAKING CHANGE NOTIFICATION!** Future releases of PSBicep _will_ require new versions of PowerShell! This is due to Bicep using new versions of .NET which forces us to use a PowerShell version with support for that.
## Installation
The Bicep PowerShell Module is published to [PowerShell Gallery](https://www.powershellgallery.com/packages/Bicep/).
```powershell
Install-Module -Name Bicep
```
### Pre-release versions
To install the latest version in development use the `-AllowPrerelease` switch.
```powershell
Install-Module -Name Bicep -AllowPrerelease
```
>**Note:** If you want to test the latest features before we've release it to PowerShell Gallery, see the [Contribution Guide](CONTRIBUTING.md) for instructions on how to manually download the dependencies and install the module manually.
## Bug report and feature requests
If you find a bug or have an idea for a new feature create an issue in the repo. Please have a look and see if a similar issue is already created before submitting.
## Contribution
If you like the Bicep PowerShell module and want to contribute you are very much welcome to do so. Please read our [Contribution Guide](CONTRIBUTING.md) before you start! ❤
## Maintainers
This project is currently maintained by the following coders:
- [StefanIvemo](https://github.com/StefanIvemo)
- [SimonWahlin](https://github.com/SimonWahlin)
- [bjompen](https://github.com/bjompen)
- [JohnRoos](https://github.com/JohnRoos)
- [PalmEmanuel](https://github.com/PalmEmanuel)
- [emilguden](https://github.com/emilguden)
[BicepIcon]: logo/BicePS_40px.png
[Bicep]: https://img.shields.io/badge/Bicep-v2.7.0-blue
[BicepPreview]: https://img.shields.io/badge/Bicep-v2.5.0--Preview1-red
[BicepDownloads]: https://img.shields.io/powershellgallery/dt/Bicep
[BicepGallery]: https://www.powershellgallery.com/packages/Bicep/
[BicepGalleryPreview]: https://www.powershellgallery.com/packages/Bicep/2.5.0-Preview1