Skip to content
Permalink
master
Go to file
3 contributors

Users who have contributed to this file

@anthony-c-martin @alex-frankel @majastrz
105 lines (83 sloc) 3.87 KB

Setup your bicep development environment

To get the best bicep authoring experience, you will need two components:

  • Bicep CLI (required) - Compiles bicep files into ARM templates. Cross-platform.
  • Bicep VS Code Extension - Authoring support, intellisense, validation. Optional, but recommended.

Install the Bicep CLI

Linux

# Fetch the latest Bicep CLI binary
curl -Lo bicep https://github.com/Azure/bicep/releases/latest/download/bicep-linux-x64
# Mark it as executable
chmod +x ./bicep
# Add bicep to your PATH (requires admin)
sudo mv ./bicep /usr/local/bin/bicep
# Verify you can now access the 'bicep' command
bicep --help
# Done!
  

macOS

# Fetch the latest Bicep CLI binary
curl -Lo bicep https://github.com/Azure/bicep/releases/latest/download/bicep-osx-x64
# Mark it as executable
chmod +x ./bicep
# Add Gatekeeper exception (requires admin)
sudo spctl --add ./bicep
# Add bicep to your PATH (requires admin)
sudo mv ./bicep /usr/local/bin/bicep
# Verify you can now access the 'bicep' command
bicep --help
# Done!
  

Windows

Installer

  • Download the latest Windows installer.
  • Run the downloaded executable. The installer does not require administrative privileges.
  • Step through the installation wizard.
  • After the installation, Bicep CLI will be added to your user PATH. If you have any command shell windows open (cmd, PowerShell, or similar), you will need to close and reopen them for the PATH change to take effect.

PowerShell

# Create the install folder
$installPath = "$env:USERPROFILE\.bicep"
$installDir = New-Item -ItemType Directory -Path $installPath -Force
$installDir.Attributes += 'Hidden'
# Fetch the latest Bicep CLI binary
(New-Object Net.WebClient).DownloadFile("https://github.com/Azure/bicep/releases/latest/download/bicep-win-x64.exe", "$installPath\bicep.exe")
# Add bicep to your PATH
$currentPath = (Get-Item -path "HKCU:\Environment" ).GetValue('Path', '', 'DoNotExpandEnvironmentNames')
if (-not $currentPath.Contains("%USERPROFILE%\.bicep")) { setx PATH ($currentPath + ";%USERPROFILE%\.bicep") }
if (-not $env:path.Contains($installPath)) { $env:path += ";$installPath" }
# Verify you can now access the 'bicep' command.
bicep --help
# Done!
  

Install the Bicep VS Code extension

Manually

  • Download the latest version of the extension. NOTE: You cannot install the vscode-bicep.vsix file by double-clicking it.
  • Open VSCode, and in the Extensions tab, select the options (...) menu in the top right corner and select 'Install from VSIX'. Provide the path to the VSIX file you downloaded.

Via command line (Linux / macOS)

# Fetch the latest Bicep VSCode extension
curl -Lo vscode-bicep.vsix https://github.com/Azure/bicep/releases/latest/download/vscode-bicep.vsix
# Install the extension
code --install-extension vscode-bicep.vsix
# Clean up the file
rm vscode-bicep.vsix
# Done!
  

Via command line (Windows PowerShell)

# Fetch the latest Bicep VSCode extension
$vsixPath = "$env:TEMP\vscode-bicep.vsix"
(New-Object Net.WebClient).DownloadFile("https://github.com/Azure/bicep/releases/latest/download/vscode-bicep.vsix", $vsixPath)
# Install the extension
code --install-extension $vsixPath
# Clean up the file
Remove-Item $vsixPath
# Done!
  

Verify the Bicep VS Code extension is running

Open a file called main.bicep VS code. If the extension is installed, you should see syntax highlighting working, and you should see the language mode in the lower right hand corner of the VS code window change to bicep.

Next steps

Now that you have the tooling installed, you can start the tutorial which will teach you full bicep capabilities:

1 - Working with a basic bicep file

You can’t perform that action at this time.