CLI Overview

The Xtarterize CLI provides commands to detect, apply, and maintain conformance configuration for JavaScript/TypeScript projects.

Available Commands

Command	Description
`xtarterize init`	Full conformance setup — detect, plan, apply
`xtarterize sync`	Update existing configs to latest templates
`xtarterize diff`	Show pending changes without applying
`xtarterize check`	Audit current conformance status
`xtarterize add <task-id>`	Apply a single conformance task
`xtarterize restore <file>`	Restore a file from backup
`xtarterize list`	List all available tasks with status

`init`

Full conformance setup. Detects your project stack, shows a plan, and applies changes.

npx xtarterize init

npx xtarterize init --dry-run

npx xtarterize init --yes

npx xtarterize init --skip lint/oxlint

npx xtarterize init --only lint/biome,ts/incremental

`sync`

Update existing project configs to match the latest conformance templates. Only shows tasks with patch or conflict status.

npx xtarterize sync
npx xtarterize sync --dry-run
npx xtarterize sync --yes

`diff`

Show what sync would change, without applying anything. Read-only.

npx xtarterize diff

`check`

Audit which tasks are conformant and which need attention.

npx xtarterize check

Output shows:

Icon	Status	Meaning
✔	`skip`	Conformant — no action needed
~	`patch`	Needs update — will be patched
✗	`new`	Missing entirely — will be created
⚠	`conflict`	Incompatible config — needs manual resolution

`add`

Apply a single conformance task.

npx xtarterize add lint/biome
npx xtarterize add ci/release
npx xtarterize add codegen/plop

`restore`

Restore a file from a previous backup.

npx xtarterize restore tsconfig.json
npx xtarterize restore biome.json

`list`

List all registered tasks grouped by category, with current status.

npx xtarterize list

Task Status Values

Each task reports one of four statuses:

Status	Meaning
`new`	File/config doesn’t exist yet
`patch`	File exists but needs additions/updates
`skip`	Already conformant, nothing to do
`conflict`	Existing config is incompatible; requires decision

Backup System

Before any file is modified, Xtarterize creates a backup in .xtarterize/backups/. You can restore any file using the restore command.

Command Relationships

flowchart TD
    A[init] -->|first run| B[check]
    A -->|preview| C[diff]
    B -->|find patches| D[sync]
    D -->|preview| C
    A -->|add one| E[add]
    A -->|undo| F[restore]
    B -->|view all| G[list]
    
    style A fill:#6366f1,color:#fff
    style D fill:#f59e0b,color:#fff
    style E fill:#22c55e,color:#fff

Explore conformance tasks →