consulx 0.1.0

# consulx — Consul KV CLI + Rust Client Library

[![Crates.io](https://img.shields.io/crates/v/consulx)](https://crates.io/crates/consulx)
[![Documentation](https://docs.rs/consulx/badge.svg)](https://docs.rs/consulx)
[![License](https://img.shields.io/crates/l/consulx)](LICENSE)
[![Downloads](https://img.shields.io/crates/d/consulx)](https://crates.io/crates/consulx)
[![Recent Downloads](https://img.shields.io/crates/dr/consulx)](https://crates.io/crates/consulx)

![SnmFDBCLI](https://srotas-suite-space.s3.ap-south-1.amazonaws.com/srotas-space.png)


**consulx** is a modern Rust toolkit for working with **Consul KV**, providing:

- 🔧 Interactive REPL (like redis-cli, but for Consul)
- 🗂️ Tree view, watch, prefix watch, edit, get-json, put-json
- ⚙️ Lightweight HTTP-only Consul client (no SDKs)
- 🌐 Integrations for Actix and Axum
- 🔁 First-class support for dynamic config & feature flags
- 🧩 Typed JSON prefix loading (`kv_list_json`)

Everything is implemented from scratch using `reqwest`.

---

## ✨ Features

### 🧵 REPL Interface
- Auto-completion (reedline)
- Commands:
  get, put, del, list, tree,
  get-json, put-json,
  edit,
  watch, watch-prefix

### 🗄️ JSON-aware KV APIs
- kv_get_json<T> — load typed JSON config
- kv_put_json<T> — write typed JSON
- kv_list_json<T> — load multiple JSON configs under a prefix

### 🔁 Watches
- Watch individual keys
- Watch entire prefixes
- Efficient blocking queries (index + wait)

### 🌍 Actix & Axum Integrations
Drop ConsulXClient into your application state.

### ⚡ Pure HTTP client
No consulrs. No SDK. No hidden magic.

---

## 🚀 Installation

```toml
[dependencies]
consulx = "0.1.0"
tokio = { version = "1", features = ["full"] }
reqwest = { version = "0.12", features = ["rustls-tls", "json"] }
serde = { version = "1", features = ["derive"] }
serde_json = "1"
```

---

## 🔧 CLI Usage

```bash
cargo install consulx
consulx
```

Specify endpoint:

```bash
CONSUL_HTTP_ADDR=http://127.0.0.1:8500 consulx
```

---

## 🖥️ REPL Commands

| Command | Description |
|--------|-------------|
| get <key> | Fetch raw value |
| put <key> <value> | Store value |
| del <key> | Delete key |
| list <prefix> | List keys |
| tree <prefix> | ASCII tree |
| get-json <key> | Pretty JSON |
| put-json <key> <json> | Validate + store |
| edit <key> | Edit in $EDITOR |
| watch <key> | Watch key |
| watch-prefix <prefix> | Watch prefix |
| help | Help |
| exit | Quit |

---

## 🧩 JSON Prefix Loading (kv_list_json)

```rust
#[derive(Deserialize)]
struct FeatureFlag {
    enabled: bool,
}

let flags = consul.kv_list_json::<FeatureFlag>("app/features/").await?;

for (key, flag) in flags {
    println!("{key} => {:?}", flag);
}
```

---

## 📦 Library API Summary

```rust
ConsulXClient::new(url)
ConsulXClient::from_env()

kv_get_raw
kv_put
kv_delete
kv_list

kv_get_json<T>
kv_put_json<T>
kv_list_json<T>

kv_watch
kv_watch_prefix
```

---

Made with ❤️ by the [Srotas Space] (https://srotas.space/open-source)


---

## 👥 Contributors

- **[Snm Maurya](https://github.com/srotas-space)** - Creator & Lead Developer
  <img src="https://srotas-suite-space.s3.ap-south-1.amazonaws.com/snm.jpeg" alt="Snm Maurya" width="80" height="80" style="border-radius: 50%;">
  [LinkedIn](https://www.linkedin.com/in/srotas-space/)


[![GitHub stars](https://img.shields.io/github/stars/srotas-space/consulx?style=social)](https://github.com/srotas-space/consulx)

---

## 📄 License

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