cuid2gen 0.1.0

A command-line tool for generating CUID2 identifiers
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

# cuid2gen

A fast and secure command-line tool for generating [CUID2](https://github.com/paralleldrive/cuid2) identifiers - Collision-resistant Unique IDs.

[![Crates.io](https://img.shields.io/crates/v/cuid2gen.svg)](https://crates.io/crates/cuid2gen)
[![Documentation](https://docs.rs/cuid2gen/badge.svg)](https://docs.rs/cuid2gen)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Features

- Generate one or multiple CUID2 identifiers
- Multiple output formats (newline-separated, comma-separated, JSON array)
- Fast and memory efficient
- Zero configuration required
- Cross-platform support

## Installation

### Using Cargo

```bash
cargo install cuid2gen
```

### Using Homebrew‰

```bash
brew install cuid2gen
```

### Using Nix

```bash
nix-env -i cuid2gen
```

## Usage

Generate a single CUID2:

```bash
cuid2gen
```

Generate multiple CUIDs:

```bash
cuid2gen -c 5
```

Generate as JSON array:

```bash
cuid2gen -c 3 --format json
```

Generate comma-separated values:

```bash
cuid2gen -c 3 --format csv
```

## Options

```
USAGE:
    cuid2gen [OPTIONS]

OPTIONS:
    -c, --count <COUNT>      Number of IDs to generate [default: 1]
    -l, --length <LENGTH>    Length of each ID (not supported in current version)
    -f, --format <FORMAT>    Output format: line (default), csv, json
    -q, --quiet             Only output errors
    -h, --help             Print help
    -V, --version          Print version
```

## Why CUID2?

CUID2s are designed to be:

- Secure: resistant to prediction and scanning attacks
- Collision-resistant: extremely low probability of duplicates
- Horizontally scalable: safe for distributed systems
- URL-safe and ASCII-safe
- Sorted by time of creation

## Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

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

### Development Setup

```bash
# Clone the repository
git clone https://github.com/yourusername/cuid2gen.git
cd cuid2gen

# Build
cargo build

# Run tests
cargo test

# Run formatter
cargo fmt

# Run linter
cargo clippy
```

## License

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

## Acknowledgments

- [CUID2](https://github.com/paralleldrive/cuid2) - The original CUID2 specification
- [cuid2-rs](https://github.com/mplanchard/cuid2-rs) - Rust implementation of CUID2