Skip to content
atomize
GitHub

Documentation

preview and validate commands

Development docs · main. Your installed version may differ.

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.

Terminal window
atomize preview <source> --inspect
atomize preview <source> --mock-story '{"id":"123","title":"Example story","estimation":8}'
ArgumentDescription
<source>Path to a YAML template file, catalog ref, or HTTPS URL
OptionDescription
--inspectOutput 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.

Terminal window
atomize preview template:backend-api --inspect
atomize preview template:backend-api \
--mock-story '{"id":"123","title":"Add password reset","estimation":8,"tags":["backend"]}'

Validate a template file for correctness and completeness.

Terminal window
atomize validate <template> [options]
ArgumentDescription
<template>Path to a YAML template file or HTTPS URL. Required.
OptionTypeDefaultDescription
-s, --strictflag-Use strict mode: warnings are treated as errors
-q, --quietflag-Suppress non-essential output
--profile <name>string-Connect to ADO using a named profile for live saved-query and custom-field validation
--output jsonstring-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 task customFields, custom fields referenced in task conditions, and filter.savedQuery
  • In interactive terminals, if ADO-backed validation is needed, Atomize can prompt you to choose offline vs online validation
  • In --strict mode, offline custom-field verification warnings are promoted to errors
Terminal window
atomize validate template:backend-api
atomize validate template:backend-api --strict
atomize validate template:backend-api --profile work-ado
atomize validate https://example.com/templates/shared.yaml
CodeMeaning
0Template is valid
1Template validation failed