Common questions

Short answers to the most common questions about Nuky.

Common questions

Do I need a .nuky/config.toml?

It is required for non-trivial repositories. Absence is allowed for exploratory usage but should emit warnings in CI.

What does nuky init do?

It creates .nuky/config.toml with explicit decisions and toolchain defaults. It is the only interactive command and does not scan or modify source files.

Where do artifacts go?

All scan and diff outputs are written under .nuky/out/ (scan.json, scan_old.json, diff_summary.txt, diff.json, diff.md).

What is NUKY_SUMMARY?

A stable, machine-readable line printed once per diff: CONTRACT_CHANGE, BEHAVIOR_CHANGE, REFACTOR_ONLY, ADDED, REMOVED.

What exit codes does nuky diff use?

0 for no contract or behavior changes, 2 for behavior-only changes, 3 when contract changes are present.

How does nuky status behave?

It runs an ephemeral scan by default and does not write artifacts unless --no-scan is used.

How does UID policy work?

uid.policy can be required, allowed, or disabled. When allowed, missing UIDs emit warnings; when required, they are errors.