dfl 0.2.0

A command-line tool for managing your dotfiles with Git.
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138


# dfl: A Git-Powered Dotfile Manager

[![Build](https://img.shields.io/badge/build-passing-brightgreen.svg)](#)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
[![Rust](https://img.shields.io/badge/Rust-stable-orange.svg)](https://www.rust-lang.org)
[![Crates.io](https://img.shields.io/crates/v/dfl.svg)](https://crates.io/crates/dfl)
[![Repo](https://img.shields.io/badge/github-aashish--thapa%2Fdfl-lightgrey.svg)](https://github.com/aashish-thapa/dfl)
[![docs.rs](https://img.shields.io/badge/docs-docs.rs-informational.svg)](https://docs.rs/dfl)

`dfl` is a simple, fast, and feature-rich command-line tool for managing your dotfiles with **Git**.
It automates moving, symlinking, and syncing your configuration files across multiple machines.

Whether you're setting up a fresh dev box or keeping your fleet consistent, `dfl` provides a seamless workflow.

---

## ✨ Features

- **Automated Workflow**: Uses Git under the hood to automatically add and commit files.
- **Centralized Repository**: Keeps all your dotfiles in one place (`~/.dfl`).
- **Easy Deployment**: A single command links all your configs on a new machine.
- **Built for Speed**: Written in Rust for a fast, reliable experience.

---

## 🚀 Installation

### 📦 Install from crates.io (recommended)

If you have Rust installed:

```bash
cargo install dfl
````

This installs the binary to `~/.cargo/bin`.
Be sure that directory is in your `PATH`.

---
## Screenshot
<img width="954" height="332" alt="image" src="https://github.com/user-attachments/assets/80584caa-3560-4492-a1a6-20dd3c4d5e4f" />


### 🔧 Build from source

1. **Clone the repository**:

   ```bash
   git clone https://github.com/aashish-thapa/dfl.git
   cd dfl
   ```

2. **Build and install the executable**:

   ```bash
   cargo build --release
   sudo mv target/release/dfl /usr/local/bin/
   ```

---

## 💡 Usage

### 1) Initialize Your Repository

Create `~/.dfl` and initialize it as a Git repo:

```bash
dfl init
```

### 2) Add and Commit a Dotfile

Automatically move a file into the repo, create a symlink back, and commit:

```bash
dfl add ~/.bashrc
```

> Tip: Repeat `dfl add` for other files like `~/.zshrc`, `~/.gitconfig`, `~/.config/nvim/init.lua`, etc.

### 3) Connect to a Remote

To save your dotfiles to a remote repository like GitHub, first create an empty repository on GitHub, then add it to your dfl project.

```bash
dfl remote add https://github.com/your-username/mydotfiles.git
```

### 4) Push and Pull Changes

Now you can easily push your changes to the remote.

```bash
dfl push
```

### 5) Deploy on a New Machine

To get the latest changes on a new machine, first clone your repository into ~/.dfl, and then pull and sync.

```bash
cd ~
git clone https://github.com/your-username/mydotfiles.git .dfl
dfl pull
dfl sync
```

(If your tool uses a different subcommand name like `deploy`, replace accordingly.)

---

## 🤝 Contributing

We welcome contributions!

1. Fork the repo
2. Create a feature branch: `git checkout -b feature/AmazingFeature`
3. Commit: `git commit -m 'feat: Add amazing feature'`
4. Push: `git push origin feature/AmazingFeature`
5. Open a Pull Request

---

## 📄 License

Licensed under the **MIT License**.
See the [LICENSE](LICENSE) file for details.

---

## 🙏 Credits

Created by [**aashish-thapa**](https://github.com/aashish-thapa).

```
```