Batfiles documentation
Keep ordinary files in Git, declare where they belong in batfiles.toml, and
run batfiles sync.
Start here
- Install batfiles, or bootstrap an existing repository.
- Create your first repository and preview an installation.
- 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
| Task | Reference |
|---|---|
| Run or preview a command | Commands and options, output, exit statuses |
| Write a manifest | Repository format, action types |
| Choose what runs on a machine | Selection, conditions |
| Compose repositories | Guide, Remotes, include-remote |
| Configure locations and variables | Environment, variable precedence |
| Choose actions and refresh content | Guide, Installation safety |
| Install a tool from GitHub releases and keep it current | Guide, github-release variables |
| Diagnose unexpected behavior | Troubleshooting |
| Look up a term | Glossary |
| Inspect machine state | State files and cache |
| Install a binary or bootstrap a checkout | Hosted installer, checkout stub |
Contributing and releasing
- AGENTS.md: branch workflow, checks, and documentation ownership.
- Product principles: the product model.
- Architecture: implementation rules, modules, and tests.
- Writing documentation: guides, references, coverage, and examples.
- Release management: repository setup and release procedure.
- Distribution: release assets, build tasks, hosting, and workflows.
- Potential enhancements: unscheduled ideas, not supported behavior.