Overview
Documentation
Section titled “Documentation”Welcome to the dotfiles management system documentation.
Table of Contents
Section titled “Table of Contents”Getting Started
Section titled “Getting Started”- Installation - How to install and bootstrap the system
- Quick Start - Get up and running in 5 minutes
- Content Overlay & Packaging - Keep your personal config/profiles/modules in a separate repo that overlays the engine
- Extending - Hands-on tutorial: build your own content repo with custom and override modules
Architecture & Design
Section titled “Architecture & Design”- Architecture - System design and component overview
- Design Rationale - Why Go, why shell, and why build from source
Module Development
Section titled “Module Development”- Creating Modules - Step-by-step guide to creating new modules
- Idempotence - How the idempotence system works
User Interface
Section titled “User Interface”- UX Features - Grid selector, progress bars, and smart output handling
- CLI Reference - Complete command-line interface reference
Operations
Section titled “Operations”- CI/CD & IaC Integration - Unattended installs in pipelines, containers, and IaC
- Troubleshooting - Common issues and solutions
- Rollback Guide - How to reverse module installations (via
uninstall)
Contributing
Section titled “Contributing”- Contributing - How to contribute to the project