Skip to content
atomize
GitHub

Documentation

Try Atomize from the CLI

Development docs · main. Your installed version may differ.

Go from installation to your first task breakdown using a built-in Template. You only need a terminal and Node.js; no Azure DevOps credentials are needed.

Install Node.js 22 or later, which includes npm. Then install Atomize and check that your terminal can find it:

Terminal window
npm install -g @sppg2001/atomize
atomize --version

The version command prints your installed CLI version. If your terminal cannot find atomize, reopen it and check that npm's global executable directory is on your PATH.

The backend-api Template is included with the CLI. You can use it directly without creating a file or installing a Catalog item:

Terminal window
atomize validate template:backend-api

This performs Offline Validation. You do not need an Azure DevOps account or a Connection Profile.

Pass a small Mock Story as JSON. Single quotes keep the JSON intact in Bash, Zsh, and PowerShell:

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

The command prints JSON containing three Tasks, each using the Mock Story's title. The Template converts the input Story Estimate of 8 into a 32-hour budget using its example conversion factor of 4, then splits it 20% / 50% / 30%. Here is a shortened transcript of the result:

tasks[0].title: Define API Behavior: Add password reset
tasks[1].title: Implement API Change: Add password reset
tasks[2].title: Verify API Behavior: Add password reset
skippedTasks: []
estimationSummary.storyEstimation: 32
estimationSummary.totalTaskEstimation: 32
estimationSummary.percentageUsed: 100

Change title or estimation in the command and run it again to see how the breakdown changes. Mock Preview neither queries a platform nor creates Work Items. The CLI is installed from npm, but this preview runs offline using the built-in Template.

To work with real Stories, set up an Azure DevOps Connection Profile and follow connected generation. A connected dry run reads Stories without creating Tasks. Task creation requires --execute and confirmation; non-interactive execution also requires --auto-approve.

See the CLI Reference for preview options, or create your own Template.