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

Batfiles documentation

Keep ordinary files in Git, declare where they belong in batfiles.toml, and run batfiles sync.

Start here

  1. Install batfiles, or bootstrap an existing repository.
  2. Create your first repository and preview an installation.
  3. Learn everyday commands and machine-specific choices.

These docs follow main. A feature not yet in a stable release is labeled Unreleased, with the build it needs. Check your installed version with batfiles version.

Find a task

TaskReference
Run or preview a commandCommands and options, output, exit statuses
Write a manifestRepository format, action types
Choose what runs on a machineSelection, conditions
Compose repositoriesGuide, Remotes, include-remote
Configure locations and variablesEnvironment, variable precedence
Choose actions and refresh contentGuide, Installation safety
Install a tool from GitHub releases and keep it currentGuide, github-release variables
Diagnose unexpected behaviorTroubleshooting
Look up a termGlossary
Inspect machine stateState files and cache
Install a binary or bootstrap a checkoutHosted installer, checkout stub

Contributing and releasing