@i4ctime/q-ring 0.2.5 → 0.2.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -12,28 +12,37 @@ Experience **superposition** (multi-environment keys), **entanglement** (linked
|
|
|
12
12
|
|
|
13
13
|
Seamlessly integrated with **Cursor**, **Kiro**, **Claude Code**, and the entire **MCP** ecosystem.
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## 🚀 Installation
|
|
16
|
+
|
|
17
|
+
q-ring is designed to be installed globally so it's available anywhere in your terminal. Pick your favorite package manager:
|
|
16
18
|
|
|
17
19
|
```bash
|
|
18
|
-
npm
|
|
20
|
+
# npm
|
|
21
|
+
npm install -g @i4ctime/q-ring
|
|
22
|
+
|
|
23
|
+
# pnpm (recommended)
|
|
24
|
+
pnpm add -g @i4ctime/q-ring
|
|
25
|
+
|
|
26
|
+
# yarn
|
|
27
|
+
yarn global add @i4ctime/q-ring
|
|
19
28
|
```
|
|
20
29
|
|
|
21
|
-
## Quick Start
|
|
30
|
+
## ⚡ Quick Start
|
|
22
31
|
|
|
23
32
|
```bash
|
|
24
|
-
# Store a secret
|
|
33
|
+
# 1️⃣ Store a secret (prompts securely if value is omitted)
|
|
25
34
|
qring set OPENAI_API_KEY sk-...
|
|
26
35
|
|
|
27
|
-
# Retrieve it
|
|
36
|
+
# 2️⃣ Retrieve it anytime
|
|
28
37
|
qring get OPENAI_API_KEY
|
|
29
38
|
|
|
30
|
-
# List all keys (values are never shown)
|
|
39
|
+
# 3️⃣ List all keys (values are never shown)
|
|
31
40
|
qring list
|
|
32
41
|
|
|
33
|
-
# Generate a cryptographic secret
|
|
42
|
+
# 4️⃣ Generate a cryptographic secret and save it
|
|
34
43
|
qring generate --format api-key --prefix "sk-" --save MY_KEY
|
|
35
44
|
|
|
36
|
-
#
|
|
45
|
+
# 5️⃣ Run a full health scan
|
|
37
46
|
qring health
|
|
38
47
|
```
|
|
39
48
|
|
|
@@ -313,6 +322,6 @@ Optional per-project configuration:
|
|
|
313
322
|
}
|
|
314
323
|
```
|
|
315
324
|
|
|
316
|
-
## License
|
|
325
|
+
## 📜 License
|
|
317
326
|
|
|
318
|
-
|
|
327
|
+
[Custom License](LICENSE) - Free for personal and internal use. Distribution, sublicensing, or resale requires explicit permission.
|