Set up your editor

For feature teams. This page shows what the Joomiz extension for VS Code does while you write a joomiz.yaml file, and how to set it up.

What you get

The extension works on files that are named joomiz.yaml. It starts a helper program. The program reads your file and the schema of your control plane. In VS Code you get these helps:

Completion. Press Ctrl+Space where a type goes, and the editor lists the types that your platform offers. In a spec, it lists the settings of the type. For artifact and target in a deployment, it lists the ids that your file declares.
Checks. The editor underlines a problem as you type, before you run joomiz validate. For example, it underlines an artifact that your file does not declare, and it names the ids that it does declare. It also underlines a ${{ ... }} reference that names nothing, and lists what exists.
Go to definition. Press F12 on an artifact or a target value to jump to its entry.
Links. An artifact or a target value that exists is a link. Hold Ctrl or Cmd and click it.
Hover. Rest the pointer on a setting to read its description.

The editor checks the structure of the file and the references between its parts. validate still checks everything against your control plane. Run it before you register or apply.

Install the extension

The VS Code extension provided by Joomiz has no download yet. Your platform team provides it.

Install the extension from the file that your platform team gives you. In VS Code, open the Extensions view, open its menu, and choose Install from VSIX.

The helper program is a Java program. It needs a Java runtime of version 25 or newer on your machine. If the extension finds no Java, it shows one error and stops. Set the setting joomiz.javaPath to the java that you want it to use.

Set the address of your control plane

The extension reads the schema from your control plane. Open the settings of VS Code, and set joomiz.serverUrl to the address of your control plane. Your platform team gives you the address. It is the same address that you use for JOOMIZ_SERVER_URL.

The schema needs no token.

Reload the schema

The extension fetches the schema when it starts, when you return to the editor window, and when you run Joomiz: Reload Schema. The automatic fetch happens at most once in 30 seconds.

To fetch it at once, open the command palette and run Joomiz: Reload Schema. Do this after your platform team adds a type.

If it does not work

Symptom	Cause	Fix
One error about Java at start	The extension found no `java`.	Install Java 25 or newer, or set `joomiz.javaPath`.
A warning that the schema could not be fetched	The control plane is not reachable at `joomiz.serverUrl`.	Check the setting. Run Joomiz: Reload Schema.
No type completion, and no checks of `spec`	The editor has no schema for this address.	Fix the address, and reload the schema.
Checks of ids and references still work	These checks need only your file.	Nothing to fix.
A type is missing in the list	Your platform does not offer it.	Ask your platform team.

If the control plane is not reachable, the checks of ids and references in your file still work. The editor also uses the last schema that it fetched from the same address.

Read answers to common questions in Questions and troubleshooting.