goobits-repos 2.1.0

Fast Git repository management and synchronization tool
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

# Installation Guide

## Prerequisites

- **Rust toolchain** (1.70+): `rustc` and `cargo`
- **Git** (2.0+)
- **Platform**: Linux or macOS (Windows via WSL)

## Installation Methods

### Method 1: Cargo Install (Recommended)

Install directly from crates.io. Fastest and simplest method.

```bash
cargo install goobits-repos
```

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

### Method 2: Install Script

Recommended for most users. Handles Rust installation, binary compilation, and PATH setup automatically. **Choose this unless you have specific requirements.**

```bash
git clone https://github.com/goobits/repos.git
cd repos
./install.sh
```

After running the script, you'll have:
- Optimized release binary built and installed
- Binary in `/usr/local/bin`, `~/.local/bin`, or `~/bin` (first writable location)
- Installation directory added to your PATH
- Rust toolchain installed if it was missing

### Method 3: Make

Familiar workflow for users who prefer make commands. Equivalent to Method 1 but uses make.

```bash
git clone https://github.com/goobits/repos.git
cd repos
make install
```

### Method 4: Cargo Direct Install

For users who want full control over installation paths and prefer manual setup.

```bash
git clone https://github.com/goobits/repos.git
cd repos
cargo build --release
mkdir -p ~/.local/bin
cp target/release/repos ~/.local/bin/
```

Requires manual PATH configuration (see below).

### Method 5: From Source (Development)

For contributors working on the codebase. Creates unoptimized debug build for faster compilation during development.

```bash
git clone https://github.com/goobits/repos.git
cd repos
cargo build
./target/debug/repos --help
```

## Verify Installation

```bash
repos --version      # Should show: repos 2.1.0
which repos          # Should show: /home/user/.local/bin/repos
repos --help         # Display command help
```

## PATH Setup

Ensure `~/.local/bin` is in your PATH:

**Bash** (`~/.bashrc`):
```bash
export PATH="$HOME/.local/bin:$PATH"
```

**Zsh** (`~/.zshrc`):
```bash
export PATH="$HOME/.local/bin:$PATH"
```

**Fish** (`~/.config/fish/config.fish`):
```fish
set -gx PATH $HOME/.local/bin $PATH
```

Apply changes:
```bash
source ~/.bashrc    # or ~/.zshrc, or restart shell
```

## Updating

```bash
cd repos
git pull
./install.sh
```

The install script rebuilds and reinstalls automatically.

## Uninstalling

```bash
rm ~/.local/bin/repos
```

Remove PATH configuration from shell RC files if desired.

## Troubleshooting

**"command not found"**
- Check PATH: `echo $PATH | grep -o "$HOME/.local/bin"`
- Verify binary exists: `ls -l ~/.local/bin/repos`
- Reload shell: `source ~/.bashrc` or restart terminal

**Build errors**
- Update Rust: `rustup update`
- Check version: `rustc --version` (need 1.70+)
- Clean rebuild: `cargo clean && cargo build --release`

**Permission denied**
- Make binary executable: `chmod +x ~/.local/bin/repos`
- Check ownership: `ls -l ~/.local/bin/repos`
- Use `sudo` only if installing to `/usr/local/bin`

**Missing dependencies on Linux**
- Install build tools: `sudo apt install build-essential pkg-config libssl-dev`
- For RHEL/Fedora: `sudo dnf install gcc openssl-devel`