Documentation menu

Commands

flog deprecate

Set or clear the deprecation message for one exact published package version.

Usage#

flog deprecate <package>@<exact-version> (--message <message> | --clear) [options]

Examples#

flog deprecate example@1.2.3 --message "Use 2.x instead" --dry-run
flog deprecate example@1.2.3 --message "Use 2.x instead"
flog deprecate @scope/example@1.2.3 --clear --json

Options and behaviour#

--message sets a non-empty message. --clear explicitly removes the warning; the two flags are mutually exclusive. The selector must contain one complete semantic version. Ranges, dist-tags, and omitted versions are rejected.

--dry-run reads the current writable registry metadata and previews the operation without mutation. --json returns a versioned outcome including the previous and requested messages, mutation-attempt count, and whether post-write metadata verification succeeded. Confirmed updates, unchanged state, conflicts, authorization failures, ambiguous writes, and accepted-but-unverified writes remain distinct. Failures exit nonzero even when the registry may have accepted a write.

The command uses normal npmrc registry and bearer-token selection. It does not publish, unpublish, move dist-tags, or edit local manifests and locks. Registry support, revision-race limitations, verification, OTP, and web-auth behavior are documented in Registry and authentication. An interactive OTP entry or web-auth confirmation authorizes at most one retry, and only after Flog has re-read the target state and writable revision.

Run flog help deprecate for complete current help.

Registry and authentication · View · Publish