dotme 0.1.2

A dotfiles manager written in Rust.
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

<!-- markdownlint-disable -->
<div align="center">
<h1>DotMe</h1>

[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)][github]
[![Crates.io Version](https://img.shields.io/crates/v/dotme?style=for-the-badge)][crates-io]
[![Crates.io Downloads (recent)](https://img.shields.io/crates/dr/dotme?style=for-the-badge)][crates-io]
[![GitHub Stars](https://img.shields.io/github/stars/42ByteLabs/dotme?style=for-the-badge)][github]
[![Licence](https://img.shields.io/github/license/42ByteLabs/dotme?style=for-the-badge)][license]

</div>
<!-- markdownlint-restore -->

A modern, simple and efficient dotfiles manager written in Rust.

DotMe allows you to easily manage your dotfiles and keep them synchronized across your system.
It supports individual files, directories, and git repositories as dotfile sources.

## Features

- 📁 Manage files, directories, and git repositories
- 🚀 Fast and async - built with Tokio
- 🔧 Simple YAML configuration
- 🎯 Automatic source type detection
- 💻 Clean CLI interface

## 📦 Installation

### Using Cargo

```bash
cargo install dotme
```

## 🚀 Quick Start

### Initialize DotMe

```bash
dotme init
```

### Add dotfiles

**Add a git repository (stored in ~/.dotme/git):**

```bash
dotme add https://github.com/user/dotfiles.git
```

### Update/sync dotfiles

Actually perform the update:

```bash
dotme update
```

### Remove dotfiles

```bash
# Remove with explicit source
dotme remove ~/.bashrc

# Interactive removal (select from list)
dotme remove
```

## 🦸 Support

Please create [GitHub Issues][github-issues] if there are bugs or feature requests.

This project uses [Semantic Versioning (v2)][semver] and with major releases, breaking changes will occur.

## 📓 License

This project is licensed under the terms of the MIT open source license.
Please refer to [MIT][license] for the full terms.

<!-- Resources -->
[license]: ./LICENSE
[semver]: https://semver.org/
[github]: https://github.com/42ByteLabs/dotme
[github-issues]: https://github.com/42ByteLabs/dotme/issues
[crates-io]: https://crates.io/crates/dotme