Skip to content

Choose the shell you use

The command examples use matching tabs throughout the site:

  • Bash/zsh for macOS, Linux, and the Codespace terminal.
  • PowerShell for Windows PowerShell 7+ or PowerShell in VS Code.

Select your shell on any paired command. The same choice is carried across the other shell tabs on the site. Commands such as python and az use the same syntax in both shells, so they may appear as a single code block instead of duplicated tabs.

Pick your shell

python --version
az --version

python --version
az --version

Know which directory the command uses

The workshop root is the project folder containing pyproject.toml, azure.yaml, and the docs/ directory. Instructions may ask you to change into docs/ or agent-framework/ for a particular task. If a command fails with “file not found,” check your current directory before changing the command.

Lab configuration helper

Two versions of the helper write the same .env file:

  • labautomation/get-keys.sh for Bash/zsh. It needs Bash 4 or later; macOS's built-in Bash 3.2 is too old. Use the Codespace or a newer Bash.
  • labautomation/get-keys.ps1 for PowerShell. It needs only Azure CLI, so no WSL or Git Bash is required.

For uploading missing sample assets, the repository also supplies labautomation/upload-assets.ps1. PowerShell users can use that script instead of upload-assets.sh after installing the Az.Accounts, Az.Resources, and Az.Storage PowerShell modules and signing in with Connect-AzAccount.

Azure CLI commands such as az login are not Bash-only. Use them from PowerShell without changing their syntax.

Activate the Python environment

Python environment activation is shell-specific. Activate the workshop environment from the workshop root:

source .venv/bin/activate

.\.venv\Scripts\Activate.ps1

If PowerShell blocks activation because of its execution policy, see Microsoft's PowerShell execution policy documentation. You can also run the environment's Python directly, for example .venv\Scripts\python.exe docs\claims-intake-agent.py --help, without activating it.

Keep credentials private

The setup scripts write secrets to the ignored .env file. Do not paste its values into a terminal command, issue, chat, screenshot, or commit. Verify configuration by checking variable names or using the documented command, not by printing the file. Prefer interactive Azure sign-in over putting credentials on a command line.