Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

apply-action

batfiles apply-action --id <id> [--dry-run]

Execute one action or clone-list entry by address, with sync’s action behavior and the shared execution options. --id is required. An action without an ID cannot be named directly.

The selection table defines which exclusions naming an action bypasses. Apply commands use existing remote materializations.

A run action runs its command whatever its trigger says, and a success is recorded as usual. A contributed one still needs its remote’s allow-commands; without it, naming the action fails.

These failures exit 1:

  • An invalid address, checked before the repository is opened.
  • An address matching nothing, with the address and manifest in the error.
  • An unread enclosing inclusion or clone list, with its name and reason.
  • An address naming an include-remote itself: it contributes actions but is not an executable action.

A contributed action excluded by inclusion filters still resolves, so naming it succeeds without installing anything. -v identifies the record and reason:

nothing to apply: the inclusion that contributed the action did not select it

See global options and output conventions.