You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+54-6Lines changed: 54 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,6 @@
1
1
# redis-async
2
2
3
-
An asynchronous Redis client library and a Redis CLI built in Rust, compliant with RES (Redis Serialization Protocol) 2 and 3, built with [Tokio][1].
4
-
Inspired by [mini-redis][2].
3
+
An asynchronous Redis client library and a Redis CLI built in Rust, compatible with RES (Redis Serialization Protocol) version 2 and 3, built with [Tokio][1]. Inspired by [mini-redis][2].
5
4
6
5
## Usage
7
6
@@ -38,7 +37,36 @@ More examples can be found in the [examples](./examples/) directory.
38
37
39
38
### Using the CLI
40
39
41
-
TBD. Not available yet.
40
+
You can install the CLI as a binary or run it with [Cargo][3].
41
+
42
+
To install as a binary into `~/.cargo/bin`:
43
+
44
+
```shell
45
+
> cargo install --path .
46
+
```
47
+
48
+
Then you can run it:
49
+
50
+
```shell
51
+
> redis-async-cli
52
+
```
53
+
54
+
To build and run without installation:
55
+
56
+
```shell
57
+
> cargo build --release --bin redis-async-cli
58
+
```
59
+
60
+
Then you can it:
61
+
62
+
```shell
63
+
> ./target/release/redis-async-cli
64
+
```
65
+
66
+
To use the CLI, you first need to run a Redis server. Then you can run this CLI in either interactive mode or command line mode:
67
+
68
+
+ Interactive mode:
69
+
+ Command line mode:
42
70
43
71
## TLS/SSL
44
72
@@ -48,13 +76,15 @@ TBD. Not available yet.
48
76
49
77
TBD. Not available yet.
50
78
79
+
## RESP2/RESP3
80
+
51
81
## Supported commands
52
82
53
83
This library is more on prototype. More commands will be added later on.
54
84
55
-
+ PING
56
-
+ GET
57
-
+ SET
85
+
+[PING][4]
86
+
+[GET][5]
87
+
+[SET][6]
58
88
+ DEL
59
89
+ EXISTS
60
90
+ EXPIRE
@@ -69,6 +99,20 @@ This library is more on prototype. More commands will be added later on.
69
99
70
100
## Development
71
101
102
+
### Local build
103
+
104
+
To build the lib:
105
+
106
+
```shell
107
+
> cargo build --lib
108
+
```
109
+
110
+
To build the CLI:
111
+
112
+
```shell
113
+
> cargo build --bin redis-async-cli
114
+
```
115
+
72
116
TBD. Thinking of which may people prefer if they don't want to install Redis on their local.
73
117
74
118
Also due to gotchas from different RESP versions and Redis versions. A local dev may be necessary to for reproducible build and test environment.
@@ -85,3 +129,7 @@ The project is licensed under the [MIT license](./LICENSE).
0 commit comments