Glossary
Terms used throughout the guides and references, each with a link to the reference that defines it.
| Term | Meaning |
|---|---|
| Action | One [[actions]] entry in a manifest: something to install, chosen by its type. See actions. |
| Address | A dotted name that selects an action or group, such as editor or team.settings for an action an inclusion contributes. See addresses. |
| Backup | Content that was in a destination’s way, set aside beside it as <dest>.batfiles-backup-<time>. Batfiles never deletes backups. See conflicts and backups. |
| Bootstrap | Adopting 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 stub | The install.sh and install.ps1 that init writes into a repository, which get batfiles if needed and bootstrap that checkout. See leaf stub. |
| Condition | A when or unless expression over variables and host facts that decides whether an action or remote takes part in a run. See conditions. |
| Destination home | The directory ~ names in a dest: your home directory unless --home-dir or BATFILES_HOME chooses another. See location selection. |
| Dry run | A preview, with --dry-run, that reports intended work without changing installed content. See dry-run behavior. |
| Dynamic variable | A 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. |
| Group | A name shared by actions so they can be applied, skipped, or disabled together. See groups. |
| Trigger | When a run action’s command runs: always, at bootstrap, once, on an interval, or after something it follows changed. See triggers. |
| Inclusion | An include-remote action, which runs actions from a remote’s own manifest. Its id prefixes their addresses. See include-remote. |
| Leaf | Your own dotfiles repository: the one whose batfiles.toml a command reads. See repository layout. |
| Machine state | Choices 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. |
| Manifest | A repository’s batfiles.toml. See repository format. |
| Materialize | Fetch or update a remote into remotes/<id> in the leaf. Only sync does this. See materialization. |
| Partial plan | A dry run that could not read some included actions because their remote has not been materialized yet. See plan completeness. |
| Remote | A Git repository, file, or archive declared under [remotes], used as a source of files or for an inclusion. See remotes. |
| Seed | Content installed once and then allowed to diverge: copies and downloads. Later runs keep it unless you refresh it. See seeds. |
| Template | A field value containing ${...} expressions, such as a per-machine dest or download URL. See templates. |
| Variable | A named string value from the manifest, machine state, environment, or --var, used in conditions and templates. See variables. |