dotr-dear 1.5.0

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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

# Installation

## Homebrew (macOS and Linux)

Supports both Apple Silicon and Intel Macs.

```bash
brew tap uroybd/tap
brew install dotr
```

## Cargo

```bash
cargo install dotr-dear
```

This installs a binary named `dotr` (the crate is published as `dotr-dear`
since `dotr` was already taken on crates.io).

## From source

```bash
cargo install --git https://github.com/uroybd/DotR
```

## Pre-built binaries

Download the latest release for your platform from the
[releases page](https://github.com/uroybd/DotR/releases):

| Platform                    | Archive                                      |
| ---------------------------- | --------------------------------------------- |
| Apple Silicon (M1/M2/M3)     | `dotr-aarch64-apple-darwin.tar.gz`            |
| Intel Mac                    | `dotr-x86_64-apple-darwin.tar.gz`             |
| Linux (x86_64)               | `dotr-x86_64-unknown-linux-gnu.tar.gz`        |
| Linux (aarch64)              | `dotr-aarch64-unknown-linux-gnu.tar.gz`       |
| Linux musl (x86_64)          | `dotr-x86_64-unknown-linux-musl.tar.gz`       |
| Linux musl (aarch64)         | `dotr-aarch64-unknown-linux-musl.tar.gz`      |

Extract and move the binary onto your `PATH`:

```bash
tar xzf dotr-*.tar.gz
sudo mv dotr /usr/local/bin/
```

## Man pages

`man dotr` (and `man dotr-deploy`, `man dotr-packages`, etc. for every
subcommand) is available if you installed via Homebrew — the formula
installs them automatically. The release tarballs also bundle the same
`.1` files alongside the binary; move them into your local man path to
use them:

```bash
tar xzf dotr-*.tar.gz
sudo mv dotr /usr/local/bin/
sudo mv dotr*.1 /usr/local/share/man/man1/
```

`cargo install` doesn't carry man pages — cargo has no mechanism for
installing them — so they aren't available that way.

## Shell completions

Unlike man pages, completions are generated at runtime by `dotr` itself,
so they work the same way no matter how you installed it:

```bash
# Bash
dotr completions bash > ~/.local/share/bash-completion/completions/dotr

# Zsh (any directory on your $fpath)
dotr completions zsh > ~/.zfunc/_dotr

# Fish
dotr completions fish > ~/.config/fish/completions/dotr.fish

# Nushell
dotr completions nushell > ~/.config/nushell/completions/dotr.nu

# Elvish and PowerShell are supported too — see their own docs for where
# to put a generated completion script.
```

Completions cover every command, including the nested `dotr packages` and
`dotr profiles` subcommands. See the
[CLI reference](../reference/cli.md#dotr-completions-shell) for details.

## Verifying the install

```bash
dotr --version
dotr --help
```