dotstate 0.2.3

A modern, secure, and user-friendly dotfile manager built with Rust
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

# Installation Guide

## Quick Install

### Using Cargo (Recommended)

```bash
cargo install dotstate
```

### From Source

```bash
# Clone the repository
git clone https://github.com/serkanyersen/dotstate.git
cd dotstate

# Build and install
cargo install --path .
```

### Using Homebrew (macOS)

```bash
# Add the tap (once)
brew tap serkanyersen/dotstate

# Install
brew install dotstate
```

Or use the direct install:
```bash
brew install serkanyersen/dotstate/dotstate
```

## Building from Source

### Prerequisites

- **Rust**: Latest stable version (1.70+)
- **Cargo**: Comes with Rust
- **Git**: For cloning the repository

### Steps

1. **Clone the repository**:
   ```bash
   git clone https://github.com/serkanyersen/dotstate.git
   cd dotstate
   ```

2. **Build in release mode**:
   ```bash
   cargo build --release
   ```

3. **Install globally** (optional):
   ```bash
   cargo install --path .
   ```

   This will install `dotstate` to `~/.cargo/bin/` (make sure it's in your PATH).

4. **Or run directly**:
   ```bash
   ./target/release/dotstate
   ```

## Verifying Installation

After installation, verify it works:

```bash
dotstate --version
```

You should see the version number.

## Troubleshooting

### Command not found

If `dotstate` is not found after installation:

1. **Check if Cargo bin directory is in PATH**:
   ```bash
   echo $PATH | grep cargo
   ```

2. **Add to PATH** (add to your `~/.zshrc` or `~/.bashrc`):
   ```bash
   export PATH="$HOME/.cargo/bin:$PATH"
   ```

3. **Reload your shell**:
   ```bash
   source ~/.zshrc  # or ~/.bashrc
   ```

### Build Errors

If you encounter build errors:

1. **Update Rust**:
   ```bash
   rustup update stable
   ```

2. **Check Rust version**:
   ```bash
   rustc --version
   ```

   Should be 1.70 or later.

3. **Clean and rebuild**:
   ```bash
   cargo clean
   cargo build --release
   ```

## Platform-Specific Notes

### macOS

- Works out of the box
- No additional dependencies required

### Linux

- May need to install development tools:
  ```bash
  # Ubuntu/Debian
  sudo apt-get install build-essential pkg-config libssl-dev

  # Fedora
  sudo dnf install gcc openssl-devel
  ```

### Windows

- Requires Visual Studio Build Tools or MinGW
- Git for Windows is recommended
- Terminal should support ANSI escape codes (Windows Terminal recommended)

## Next Steps

After installation, see the [README.md](README.md) for usage instructions.

### First-time Setup

When you first run `dotstate`, you'll be asked to choose a setup mode:

1. **Create for me (GitHub)**: DotState creates a repository on your GitHub account
   - Requires a GitHub Personal Access Token
   - Best for simple, automated setup

2. **Use my own repository**: Bring your own git repository
   - Works with GitHub, GitLab, Bitbucket, or any git host
   - Uses your existing SSH keys or git credentials
   - No token required