Documentation
preview and validate commands
Development docs · main. Your installed version may differ.
preview
Section titled “preview”Inspect template field requirements or simulate task generation against a mock story. This command does not connect to Azure DevOps and does not create tasks.
atomize preview <source> --inspectatomize preview <source> --mock-story '{"id":"123","title":"Example story","estimation":8}'Arguments
Section titled “Arguments”| Argument | Description |
|---|---|
<source> | Path to a YAML template file, catalog ref, or HTTPS URL |
Options
Section titled “Options”| Option | Description |
|---|---|
--inspect | Output JSON describing which story fields the template references |
--mock-story <json> | JSON object of mock story field values to preview against |
--inspect and --mock-story are mutually exclusive. One of them is required.
Examples
Section titled “Examples”atomize preview template:backend-api --inspect
atomize preview template:backend-api \ --mock-story '{"id":"123","title":"Add password reset","estimation":8,"tags":["backend"]}'validate
Section titled “validate”Validate a template file for correctness and completeness.
atomize validate <template> [options]Arguments
Section titled “Arguments”| Argument | Description |
|---|---|
<template> | Path to a YAML template file or HTTPS URL. Required. |
Options
Section titled “Options”| Option | Type | Default | Description |
|---|---|---|---|
-s, --strict | flag | - | Use strict mode: warnings are treated as errors |
-q, --quiet | flag | - | Suppress non-essential output |
--profile <name> | string | - | Connect to ADO using a named profile for live saved-query and custom-field validation |
--output json | string | - | Print the validation result as JSON to stdout and suppress human-readable output |
See Validation Modes for a full explanation of strict vs lenient behavior.
Validation modes for ADO-backed features:
- Without
--profile, validation runs offline and checks template structure only - With
--profile, Atomize connects to ADO to validate taskcustomFields, custom fields referenced in task conditions, andfilter.savedQuery - In interactive terminals, if ADO-backed validation is needed, Atomize can prompt you to choose offline vs online validation
- In
--strictmode, offline custom-field verification warnings are promoted to errors
Examples
Section titled “Examples”atomize validate template:backend-apiatomize validate template:backend-api --strictatomize validate template:backend-api --profile work-adoatomize validate https://example.com/templates/shared.yamlExit Codes
Section titled “Exit Codes”| Code | Meaning |
|---|---|
0 | Template is valid |
1 | Template validation failed |