Quick Start
Quick start
This is the shortest path to a working setup.
1) Initialize
hometree initIf you haven't installed hometree yet, see docs/install.md.
This creates:
- A config file at
~/.config/hometree/config.toml(XDG-aware) - A bare repo at
~/.local/share/hometree/repo.git
2) Track files
hometree track ~/.config/myapp/config.tomltrack adds paths to the managed set if they are under managed roots or you pass --allow-outside.
3) Stage and snapshot
hometree snapshot -m "track config"Snapshots are git commits created from staged changes.
4) Verify
hometree verify --strictUse --with-secrets to control secrets verification:
hometree verify --with-secrets=presence
hometree verify --with-secrets=decrypt --show-paths5) Deploy and rollback (optional)
Preview first:
hometree plan deploy HEADDeploy a commit:
hometree deploy HEADRollback one generation:
hometree rollback --steps 1Common next steps
- Edit
docs/config.mdto customize managed roots or ignore patterns. - Enable the daemon if you want event-driven staging:
docs/daemon.md. - Add secrets support:
docs/secrets.md.