Coder provides a JSON Schema for workspace templates that enables code completion and syntax checking.
Requirements
You must have the YAML extension by Red Hat installed to use this feature.
How to use
Create a file called coder.yaml
, and add the following to the top (be sure to
replace the <deployment_url>
placeholder with your Coder deployment URL):
# yaml-language-server: $schema=https://<deployment_url>/api/private/template/schemas/wac.schema.json
# Write your YAML config here
At this point, you can use the code completion and syntax checking features.
Keyboard shortcuts
Some keyboard shortcuts you may find helpful include:
- Document outlining (Ctrl + Shift + O)
- Auto completion (Ctrl + Space)
See the YAML extension by Red Hat docs for additional shortcuts.
See an opportunity to improve our docs? Make an edit.
On this page