rivven 0.0.21

Command-line interface for Rivven event streaming platform
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

# rivven

> Command-line interface for the Rivven event streaming platform.

## Overview

`rivven` provides a CLI for managing topics, producing/consuming messages, and administering consumer groups. Designed for both interactive use and scripting.

For CDC (Change Data Capture), use the separate `rivven-connect` binary.

## Installation

```bash
cargo install rivven
```

## Quick Start

```bash
# Check connectivity
rivven ping --server 127.0.0.1:9092

# Create a topic
rivven topic create my-topic --partitions 3

# Produce a message
rivven produce my-topic "Hello, Rivven!"

# Consume messages
rivven consume my-topic --partition 0 --offset 0 --max 10
```

## Commands

### Topic Management

```bash
# List all topics
rivven topic list

# Create topic with partitions (default: 3)
rivven topic create my-topic --partitions 6

# Get topic metadata (name + partition count)
rivven topic info my-topic

# Delete a topic
rivven topic delete my-topic
```

### Produce Messages

```bash
# Produce a message (positional arguments: topic, message)
rivven produce my-topic "Hello, Rivven!"

# Produce with a key
rivven produce my-topic '{"event": "login"}' --key user-123

# Produce to a specific partition
rivven produce my-topic "partitioned" --partition 0

# Connect to a different server
rivven produce my-topic "msg" --server 10.0.0.1:9092
```

### Consume Messages

```bash
# Consume from partition 0, offset 0 (defaults)
rivven consume my-topic

# Consume from a specific partition and offset
rivven consume my-topic --partition 2 --offset 100

# Limit number of messages (default: 100)
rivven consume my-topic --max 10

# Follow mode — continuously consume new messages (like tail -f)
rivven consume my-topic --follow
```

### Consumer Group Management

```bash
# List all consumer groups
rivven group list

# Describe a group (show committed offsets per topic/partition)
rivven group describe my-group

# Delete a consumer group
rivven group delete my-group
```

### Connectivity

```bash
# Ping the server
rivven ping

# Ping a specific server
rivven ping --server 10.0.0.1:9092
```

## Global Options

All commands accept `--server <address>` to override the default server address (`127.0.0.1:9092`).

## Documentation

- [Getting Started](https://rivven.hupe1980.github.io/rivven/docs/getting-started)

## License

Apache-2.0. See [LICENSE](../../LICENSE).