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

Glossary

Terms used throughout the guides and references, each with a link to the reference that defines it.

TermMeaning
ActionOne [[actions]] entry in a manifest: something to install, chosen by its type. See actions.
AddressA dotted name that selects an action or group, such as editor or team.settings for an action an inclusion contributes. See addresses.
BackupContent that was in a destination’s way, set aside beside it as <dest>.batfiles-backup-<time>. Batfiles never deletes backups. See conflicts and backups.
BootstrapAdopting a repository’s suggested disabled actions and groups on a machine’s first run, done by clone and sync --bootstrap. See what the bootstrap decides.
Checkout stubThe install.sh and install.ps1 that init writes into a repository, which get batfiles if needed and bootstrap that checkout. See leaf stub.
ConditionA when or unless expression over variables and host facts that decides whether an action or remote takes part in a run. See conditions.
Destination homeThe directory ~ names in a dest: your home directory unless --home-dir or BATFILES_HOME chooses another. See location selection.
Dry runA preview, with --dry-run, that reports intended work without changing installed content. See dry-run behavior.
Dynamic variableA variable whose value is captured, by running a command or looking up a GitHub repository’s latest release, and cached between runs. See dynamic variables.
GroupA name shared by actions so they can be applied, skipped, or disabled together. See groups.
TriggerWhen a run action’s command runs: always, at bootstrap, once, on an interval, or after something it follows changed. See triggers.
InclusionAn include-remote action, which runs actions from a remote’s own manifest. Its id prefixes their addresses. See include-remote.
LeafYour own dotfiles repository: the one whose batfiles.toml a command reads. See repository layout.
Machine stateChoices and caches stored on one machine, outside any repository: vars.toml, disabled.toml, the dynamic-variable cache, and the run-action history. See state files.
ManifestA repository’s batfiles.toml. See repository format.
MaterializeFetch or update a remote into remotes/<id> in the leaf. Only sync does this. See materialization.
Partial planA dry run that could not read some included actions because their remote has not been materialized yet. See plan completeness.
RemoteA Git repository, file, or archive declared under [remotes], used as a source of files or for an inclusion. See remotes.
SeedContent installed once and then allowed to diverge: copies and downloads. Later runs keep it unless you refresh it. See seeds.
TemplateA field value containing ${...} expressions, such as a per-machine dest or download URL. See templates.
VariableA named string value from the manifest, machine state, environment, or --var, used in conditions and templates. See variables.