Start
Documentation
Start here. Then go deeper.
The Manual
The complete reference is the .dotfiles Manual — a multi-format book covering every concept, tutorial, reference, and recipe.
- Online: https://doc.dotfiles.io/manual/ (single-page HTML, PDF, EPUB and ASCII editions are attached to each release)
- Locally:
dot manualopens the HTML in your browser - Sources:
docs/manual/(published at /manual/)
Quick jumps into the Manual:
- Introduction — who, what, how
- Concepts — architecture, trust model, theme engine, fleet, self-healing
- Tutorials — first install, wallpaper→theme, profiles, secrets, fleet
- Reference — CLI, config files, environment, templates, feature flags
- Cookbook — 40+ recipes, troubleshooting, FAQ
Start
Daily use
- Utilities and
dotCLI - Operations
- Trusted agent workstation
- Workstation attestation
- Interoperability
- Agent interoperability
- AI integrations
Security and trust
Build and maintain
- Testing
- Reliability
- Naming conventions
- Architecture
- Repository layout
- AI cost optimization
- Release pipeline
- Architecture decisions
Repository map
| Path | Purpose |
|---|---|
docs/ | Guides, reference, security, and architecture |
scripts/ | Repo-only scripts and dot command internals |
install/ | Installer and provisioning helpers |
dot_config/ | Managed user configuration files |
dot_local/ | Managed local executables |
examples/ | Executable examples |
tests/ | Unit, integration, and framework coverage |