b58uuid-cli 1.0.0

Compact Base58 UUID Encoder CLI - Convert UUIDs to 22-character Base58 format
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286

# B58UUID CLI

[![Crates.io](https://img.shields.io/crates/v/b58uuid-cli.svg)](https://crates.io/crates/b58uuid-cli)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Rust](https://img.shields.io/badge/rust-1.70%2B-blue.svg)](https://www.rust-lang.org)

Command-line tool for converting UUIDs to compact 22-character Base58 format.

**Website:** [b58uuid.io](https://b58uuid.io)

## Features

- ✨ Convert UUID to B58UUID (36 chars → 22 chars)
- 🔄 Convert B58UUID back to UUID
- 🎲 Generate random B58UUIDs
- 📝 Batch processing from files
- 🔍 Validate UUID and B58UUID formats
- 🎨 Colored output
- ⚡ Fast and lightweight
- 🚀 Zero dependencies at runtime

## Installation

### cargo (Recommended)

```bash
cargo install b58uuid-cli
```

### Homebrew (macOS/Linux)

```bash
brew tap b58uuid/tap
brew install b58uuid
```

### Scoop (Windows)

```powershell
scoop bucket add b58uuid https://github.com/b58uuid/scoop-bucket
scoop install b58uuid
```

### Shell Script (macOS/Linux)

```bash
curl -fsSL https://raw.githubusercontent.com/b58uuid/b58uuid-cli/main/install.sh | sh
```

### PowerShell (Windows)

```powershell
iwr -useb https://raw.githubusercontent.com/b58uuid/b58uuid-cli/main/install.ps1 | iex
```

### Manual Download

Download pre-compiled binaries from [GitHub Releases](https://github.com/b58uuid/b58uuid-cli/releases/latest).

## Usage

### Encode UUID to B58UUID

```bash
# Encode a single UUID
b58uuid encode 550e8400-e29b-41d4-a716-446655440000
# Output: BWBeN28Vb7cMEx7Ym8AUzs

# Encode from stdin
echo "550e8400-e29b-41d4-a716-446655440000" | b58uuid encode

# Encode from file
b58uuid encode --file uuids.txt
```

### Decode B58UUID to UUID

```bash
# Decode a single B58UUID
b58uuid decode BWBeN28Vb7cMEx7Ym8AUzs
# Output: 550e8400-e29b-41d4-a716-446655440000

# Decode from stdin
echo "BWBeN28Vb7cMEx7Ym8AUzs" | b58uuid decode

# Decode from file
b58uuid decode --file b58uuids.txt
```

### Generate Random B58UUIDs

```bash
# Generate one B58UUID
b58uuid generate

# Generate multiple B58UUIDs
b58uuid generate --count 5

# Generate as standard UUID
b58uuid generate --uuid
```

### Validate Format

```bash
# Validate UUID or B58UUID
b58uuid validate 550e8400-e29b-41d4-a716-446655440000
b58uuid validate BWBeN28Vb7cMEx7Ym8AUzs
```

### Options

```bash
# Disable colored output
b58uuid --no-color encode <uuid>

# Show version
b58uuid --version

# Show help
b58uuid --help
b58uuid encode --help
```

## Examples

### Basic Usage

```bash
# Encode
$ b58uuid encode 550e8400-e29b-41d4-a716-446655440000
BWBeN28Vb7cMEx7Ym8AUzs

# Decode
$ b58uuid decode BWBeN28Vb7cMEx7Ym8AUzs
550e8400-e29b-41d4-a716-446655440000

# Generate
$ b58uuid generate
BWBeN28Vb7cMEx7Ym8AUzs
```

### Batch Processing

```bash
# Create a file with UUIDs
cat > uuids.txt << EOF
550e8400-e29b-41d4-a716-446655440000
6ba7b810-9dad-11d1-80b4-00c04fd430c8
6ba7b811-9dad-11d1-80b4-00c04fd430c8
EOF

# Encode all UUIDs
b58uuid encode --file uuids.txt
```

### Pipeline Usage

```bash
# Generate and encode
uuidgen | b58uuid encode

# Encode multiple UUIDs
cat uuids.txt | b58uuid encode

# Decode multiple B58UUIDs
cat b58uuids.txt | b58uuid decode
```

### Validation

```bash
# Validate UUID
$ b58uuid validate 550e8400-e29b-41d4-a716-446655440000
✓ Valid UUID
  UUID:    550e8400-e29b-41d4-a716-446655440000
  B58UUID: BWBeN28Vb7cMEx7Ym8AUzs

# Validate B58UUID
$ b58uuid validate BWBeN28Vb7cMEx7Ym8AUzs
✓ Valid B58UUID
  B58UUID: BWBeN28Vb7cMEx7Ym8AUzs
  UUID:    550e8400-e29b-41d4-a716-446655440000
```

## Why B58UUID?

### Compact Format

- **Standard UUID**: 36 characters
  ```
  550e8400-e29b-41d4-a716-446655440000
  ```

- **B58UUID**: 22 characters (39% shorter)
  ```
  BWBeN28Vb7cMEx7Ym8AUzs
  ```

### Benefits

- ✅ **Shorter URLs**: Better for REST APIs and web applications
- ✅ **URL-Safe**: No special characters that need encoding
- ✅ **Human-Readable**: No confusing characters (0, O, I, l)
- ✅ **Database Efficient**: Smaller indexes, faster queries
- ✅ **Copy-Paste Friendly**: Easier to select and copy

## Performance

- **Binary Size**: ~475KB (optimized for size)
- **Startup Time**: Instant (<5ms)
- **Memory Usage**: Minimal (<5MB)
- **Processing Speed**: Fast (handles millions of UUIDs efficiently)

## Building from Source

```bash
# Clone the repository
git clone https://github.com/b58uuid/b58uuid-cli.git
cd b58uuid-cli

# Build release binary
cargo build --release

# Install locally
cargo install --path .

# Run tests
cargo test
```

## Cross-Compilation

```bash
# Install cross
cargo install cross

# Build for Linux
cross build --release --target x86_64-unknown-linux-gnu

# Build for macOS
cross build --release --target x86_64-apple-darwin
cross build --release --target aarch64-apple-darwin

# Build for Windows
cross build --release --target x86_64-pc-windows-gnu
```

## Libraries

B58UUID is available in multiple languages:

- **Rust**: [b58uuid](https://crates.io/crates/b58uuid)
- **Go**: [b58uuid-go](https://github.com/b58uuid/b58uuid-go)
- **JavaScript**: [b58uuid](https://www.npmjs.com/package/b58uuid)
- **Java**: [b58uuid](https://search.maven.org/artifact/io.b58uuid/b58uuid)
- **Python**: [b58uuid](https://pypi.org/project/b58uuid/)

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Links

- **Website**: [b58uuid.io](https://b58uuid.io)
- **Documentation**: [docs.rs/b58uuid-cli](https://docs.rs/b58uuid-cli)
- **Repository**: [github.com/b58uuid/b58uuid-cli](https://github.com/b58uuid/b58uuid-cli)
- **Issues**: [github.com/b58uuid/b58uuid-cli/issues](https://github.com/b58uuid/b58uuid-cli/issues)
- **Crates.io**: [crates.io/crates/b58uuid-cli](https://crates.io/crates/b58uuid-cli)

## Acknowledgments

- Uses Bitcoin's Base58 alphabet
- Built with [clap](https://github.com/clap-rs/clap) for CLI parsing
- Powered by [b58uuid](https://crates.io/crates/b58uuid) library