VS Code
VS Code validation, settings, and recovery
Development docs · main. Your installed version may differ.
Check your Template offline before configuring a platform connection. Editor preferences control presentation; they do not change what the Template generates.
Validate without a connection
Section titled “Validate without a connection”Validates the active Template and opens a Validation Report for explicit runs.
The picker supports:
- Offline Validation, which checks Template structure without a platform connection
- Online Validation, which uses a selected Connection Profile for checks that require platform metadata
Save-time validation is passive. It updates diagnostics without opening a panel or moving editor focus.
Configure the editor
Section titled “Configure the editor”Run Atomize: Open Settings from the Command Palette.
| Setting | Purpose |
|---|---|
atomize.cliPath | Deprecated: no longer used. The extension runs Atomize in-process and no longer spawns a CLI executable. |
atomize.cli.installCommand | Deprecated: no longer used. |
atomize.cli.autoCheckUpdates | Deprecated: no longer used. |
atomize.ai.model | The Copilot model family to use for AI drafting, such as gpt-4o. Leave as auto (the default) to use the available Copilot model with the largest input limit, since grounded requests carry project metadata, Stories and Reference Documents. If the model you choose isn't available, Atomize offers to switch back to auto. |
atomize.defaultProfile | Workspace-scoped profile name to preselect in Validate, Live Preview, and Generate pickers. When blank or unknown, pickers preselect the profile marked Set as default in Atomize: Manage Profiles. |
atomize.schemaReference.openMode | Schema Reference layout: beside or editor (default). Applies on the next command invocation. |
atomize.previewLayout | Preview panel layout: default or compact. |
The workspace default profile only preselects a Connection Profile. The user still confirms the profile before connected commands run, and explicit validation always offers Offline Validation.
VS Code’s own editor.codeLens setting controls whether CodeLens is visible. For YAML language-service features, yaml.hover, yaml.completion, and yaml.validate control hovers, completion, and YAML schema diagnostics. Atomize’s save-time Validation Diagnostics are a separate check. Use the [yaml] section in editor settings when you want an editor preference to apply only to YAML files.
Troubleshoot the offline workflow
Section titled “Troubleshoot the offline workflow”Deprecated CLI Settings Notice
Section titled “Deprecated CLI Settings Notice”If you see a one-time notice about atomize.cliPath, atomize.cli.installCommand, or atomize.cli.autoCheckUpdates, it means one of those settings is still set from an earlier version of the extension. They're no-ops now (the extension runs Atomize in-process) and can be safely removed from your settings.
Connected Commands Need A Profile
Section titled “Connected Commands Need A Profile”Run Atomize: Manage Profiles to add and test a Connection Profile. For full credential setup, see VS Code profile setup and connection troubleshooting.
Schema Hovers Or Completions Are Missing
Section titled “Schema Hovers Or Completions Are Missing”Install or enable the Red Hat YAML extension, check that the document language is YAML, and check yaml.hover and yaml.completion. Prefer a Durable Atomize YAML Opt-In marker such as .atomize.yaml, .atomize.yml, or # atomize-yaml on the first line. If the language service is still not responding, use Developer: Reload Window and reopen the file.
CodeLens Actions Are Missing
Section titled “CodeLens Actions Are Missing”CodeLens actions are shown for Durable Atomize YAML Opt-In Templates when editor.codeLens is enabled. Rename the file to .atomize.yaml or add # atomize-yaml on the first line. Content detection alone does not enable CodeLens, and Mixins do not offer runnable Template actions.
Offline Commands Cannot Complete
Section titled “Offline Commands Cannot Complete”Save the intended Template content before retrying. The preview and Resolved Template commands use saved files, so an unsaved buffer is not automatically what they evaluate. A validation runner failure keeps existing diagnostics unchanged; those messages may describe an earlier successful validation, not the current contents. Fix the reported problem, then run Offline Validation again.
For missing Catalog or composition refs, check their names and scopes, or open the backing file to confirm it is available. A Mixin cannot be previewed independently. These offline actions do not need a Connection Profile; adding credentials does not fix malformed YAML or an unresolved local reference. If the extension is unresponsive, use Developer: Reload Window after saving your work.
Continue with a connection
Section titled “Continue with a connection”Use VS Code profile setup for the extension’s own Connection Profiles. Then run a Live Preview before you generate Tasks. Fix connection problems covers rejected tokens and missing permissions.