VSCode Extension
We provide a BAML VSCode extension: https://marketplace.visualstudio.com/items?itemName=Boundary.baml-extension
Opening BAML Playground
Once you open a .baml file, in VSCode, you should see a small button over every BAML function: Open Playground.
Or type BAML Playground in the VSCode Command Bar (CMD + Shift + P or CTRL + Shift + P) to open the playground.
Setting Env Variables
Click on the Settings button in top right of the playground and set the environment variables.
It should have an indicator if any unset variables are there.
The playground should persist the environment variables between closing and opening VSCode.
You can set environment variables lazily. If anything is unset you’ll get an error when you run the function.
Environment Variables are stored in VSCode’s local storage! We don’t save any additional data to disk, or send them across the network.
Running Tests
- Click on
Run tests belowin the right pane of the playground to run all tests.
- Press the
▶️button next to an individual test case to run that just that test case.
Reviewing Tests
-
Click the numbers on the left to switch between test results.
-
Press the
▶️button next to the drop-down to re-run your tests.
- Toggle the
🚀to enable running the tests in parallel.
Switching Functions
The playground will automatically switch to the function you’re currently editing.
To manually change it, click on the current function name in the playground (next to the dropdown) and search for your desired function.
Switching Test Cases
You can switch between test cases by selecting it in the results pane or the test selection pane on the right.
You can customize what you see in the Table View, or switch to the Detailed view:
