dotporter 0.1.1

A CLI tool to manage your dotfiles
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
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
139
140
141
142
143

# DotPorter 🔄

[![Rust](https://img.shields.io/badge/Built%20with-Rust-orange)](https://www.rust-lang.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
![Crates.io Version](https://img.shields.io/crates/v/dotporter)
![Crates.io Size](https://img.shields.io/crates/size/dotporter)
![Crates.io Total Downloads](https://img.shields.io/crates/d/dotporter)

> A powerful Rust-based tool for managing and synchronizing your dotfiles and packages across different machines.

## dotporter Crate

The `dotporter` crate is now published on [crates.io](https://crates.io/crates/dotporter). You can add it to your project by including the following in your `Cargo.toml`:

```toml
[dependencies]
dotporter = "0.1"  # Replace "0.1" with the latest version if needed
```
Or just install it globally with
```bash
cargo install dotporter
```
## 📁 Tool Structure


| Folder                  | Description                                       |
| :------------------------ | :-------------------------------------------------- |
| 📂**MANUAL_BACKUP**     | Storage for manual backup files (legacy version)  |
| 📂**LEGACY_DEPRECATED** | Archive of old scripts for reference              |
| 📂**dotfiles**          | Synchronized configuration files (auto-populated) |
| 📂**Packages**          | Package management and backup files               |

## 🚀 How does it work

### New Released Version (Rust-based)

1. Run the following command:

```bash
cargo run --bin Dotporter
```

This will automatically create a config file in your home directory:

```
~/dotporter/backup_config.toml
```

<details>
<summary>📸 Configuration Preview</summary>

![Config Preview](./screenshots/config.png "backup_config.toml")

</details>

The configuration file can be customized to include or exclude:

- Package managers
- Folders
- Specific files

After completion, two main folders will be created:

- 📁 Dotfiles
- 📁 Packages

<details>
<summary>📸 Result Structure</summary>

![Dotfiles Structure](./screenshots/dotfiles.png "dotfiles")
![Packages Structure](./screenshots/packages.png "packages")

</details>

### Legacy Version

<details>
<summary>Click to expand legacy version details</summary>

The root directory contains backup references for:

- **🐚 Shell Settings**: Themes and plugins for [Oh My Zsh](https://ohmyz.sh/)
- **📄 .zshrc**: [Zsh](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH) configuration
- **🎨 personal-zsh-theme**: Custom theme inspired by [daivasmara](https://github.com/Daivasmara/daivasmara.zsh-theme)
- **⚙️ settings.zip**: PHPStorm configuration

#### Scripts Usage

1. Backup your packages:

```bash
chmod a+x ./scripts/backup-packages.sh
./backup-packages.sh
```

2. Restore on new machine:

```bash
chmod a+x ./scripts/packages/brew-bulk-install.sh
chmod a+x ./scripts/packages/packages-reinstall.sh
./brew-bulk-install.sh
./packages-reinstall.sh
```

</details>

## 🛠 Dependencies

Required tools for the new machine:


| Tool                                                             | Purpose                                                                                                                   |
| :----------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------- |
| [🍺 Brew](https://brew.sh/)                                      | Package Manager for macOS                                                                                                 |
| [💎 RubyGems](https://rubygems.org/)                             | Ruby Package Manager                                                                                                      |
| [📦 Node Package Managers](https://yarnpkg.com/)                 | Choose from:[Yarn](https://yarnpkg.com/), [NPM](https://www.npmjs.com/), [BUN](https://bun.sh/), [PNPM](https://pnpm.io/) |
| [🎼 Composer](https://getcomposer.org/)                          | PHP Package Manager                                                                                                       |
| [🐍 Pip](https://pypi.org/project/pip/)                          | Python Package Manager                                                                                                    |
| [🦀 Cargo](https://crates.io/)                                   | Rust Package Manager                                                                                                      |
| [📜 Atuin](https://github.com/atuinsh/atuin)                     | Shell History Manager                                                                                                     |
| [🐚 ZSH](https://github.com/ohmyzsh/ohmyzsh/wiki/Installing-ZSH) | Shell (Optional)                                                                                                          |

## ⚠️ Important Notes

- **Beta Feature**: Package installation binary is available but untested

```bash
cargo run --bin install
```

- **Composer Packages**: Consider manual `composer.json` copy and install
- **Config Backup**: Current release focuses on configuration backup

## 🤝 Contributing

Feel free to:

- Submit issues
- Create pull requests
- Suggest enhancements
- Made with ❤️ by [📧 hamzahasbi](mailto:hamza.hasbi@gmail.com)

---