dotr-dear 2.0.1

A dotfiles manager as dear as a daughter.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

# Introduction

DotR is a dotfiles manager that is as dear as a daughter.

It keeps a repository of your configuration files ("dotfiles") separate from
where they're actually used on disk, and manages copying — or symlinking —
them into place. The repository is the source of truth; your `~/.bashrc`,
`~/.config/nvim/`, and friends are deployments of it.

<div id="intro-cast"></div>
<script>
  // asciinema-player.min.js loads at the end of <body>, after this inline
  // script in document order, so defer the create() call until load.
  window.addEventListener("load", function () {
    AsciinemaPlayer.create(
      "/assets/casts/quick-start.cast",
      document.getElementById("intro-cast"),
      { theme: "monokai", fit: "width", terminalFontSize: "14px" }
    );
  });
</script>

## Why DotR?

- **Plain files, not magic.** Your dotfiles repository is just files and
  directories under `dotfiles/`, described by a single `config.toml`.
- **Copy or symlink, your choice.** Deploy as copies for a snapshot-based
  workflow, or as symlinks for live-editing.
- **Environment-aware.** [Profiles](./concepts/profiles.md) let the same
  repository describe different machines — work, home, server — with
  different packages, variables, and destinations.
- **Templated when you need it.** Config files can embed
  [Tera](https://keats.github.io/tera/) template syntax, compiled at deploy
  time with live variables, so the same template can render differently per
  machine or profile.
- **Hooks for the messy parts.** [Pre/post actions](./concepts/actions.md)
  run shell commands around deployment — installing dependencies, reloading a
  service, fixing permissions.
- **Safe by default.** [Dry-run mode](./concepts/dry-run.md) previews every
  operation, [diff](./reference/cli.md#dotr-diff) shows exactly what would
  change, and deploys only touch files that actually changed.

## How it fits together

1. You **import** an existing file or directory into the repository:
   `dotr import ~/.bashrc`. DotR copies it into `dotfiles/` and registers it
   as a *package* in `config.toml`.
2. On a new machine, you **deploy**: `dotr deploy`. DotR copies (or
   symlinks) every package from the repository to its destination.
3. After editing a deployed file, you **update**:
   `dotr update`. DotR copies the changed file back into the repository, so
   `dotfiles/` always reflects what's actually deployed.

Everything else in this book — profiles, variables, templating, actions,
prompts, symlinks, clean mode, ignoring files, dependencies — builds on that
loop.

## Where to go next

- New to DotR? Start with [Installation](./getting-started/installation.md)
  and [Quick Start](./getting-started/quick-start.md).
- Looking for a specific flag or config field? Jump straight to the
  [CLI Reference](./reference/cli.md) or
  [Configuration File Reference](./reference/configuration.md).