@dataramen/cli 0.0.8 → 0.0.9
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 +67 -0
- package/dist/README.md +0 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# 🍜 Data Ramen CLI
|
|
2
|
+
|
|
3
|
+
**Your cozy corner for exploring and working with SQL databases — no query writing required (unless you want to).**
|
|
4
|
+
|
|
5
|
+
Data Ramen CLI lets you launch a powerful, local database exploration app that connects effortlessly to MySQL and PostgreSQL databases. Browse schemas, follow relationships, insert data, and even write raw SQL — all from your browser.
|
|
6
|
+
|
|
7
|
+
## ✨ Features
|
|
8
|
+
|
|
9
|
+
- 🔌 **Connect to PostgreSQL & MySQL**
|
|
10
|
+
Securely plug in your credentials — you're ready to explore.
|
|
11
|
+
|
|
12
|
+
- 🧭 **Visual Schema Explorer**
|
|
13
|
+
Instantly browse tables, columns, types, primary/foreign keys, and relationships.
|
|
14
|
+
|
|
15
|
+
- 🧙 **No-SQL Querying**
|
|
16
|
+
Filter, sort, join, and summarize data using a beautiful, intuitive interface.
|
|
17
|
+
|
|
18
|
+
- 🔗 **Follow Relationships Easily**
|
|
19
|
+
Click to expand related records like nested tables.
|
|
20
|
+
|
|
21
|
+
- ✏️ **Insert & Update Visually**
|
|
22
|
+
Add or modify rows with a visual editor — no SQL errors.
|
|
23
|
+
|
|
24
|
+
- 💾 **Save Queries**
|
|
25
|
+
Save your favorite views for quick access later.
|
|
26
|
+
|
|
27
|
+
- ⌨️ **Raw SQL Mode Available**
|
|
28
|
+
Prefer typing? Drop into SQL mode anytime and run your own queries.
|
|
29
|
+
|
|
30
|
+
## 🛠️ Installation
|
|
31
|
+
|
|
32
|
+
### 1. Install Node.js
|
|
33
|
+
|
|
34
|
+
Data Ramen requires Node.js **v22 or above**.
|
|
35
|
+
👉 [Download Node.js](https://nodejs.org/)
|
|
36
|
+
|
|
37
|
+
### 2. Install Data Ramen CLI
|
|
38
|
+
|
|
39
|
+
Open your terminal and run:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
npm i -g @dataramen/cli
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## 🖥️ Usage
|
|
46
|
+
|
|
47
|
+
### Start the Local Server
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
dataramen start
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Open the App
|
|
54
|
+
|
|
55
|
+
Go to https://app.dataramen.xyz in your browser. Your local server will connect automatically.
|
|
56
|
+
|
|
57
|
+
## 🔧 Additional CLI Commands
|
|
58
|
+
|
|
59
|
+
| Command | Description |
|
|
60
|
+
| ----------------- | --------------------------------- |
|
|
61
|
+
| `dataramen start` | Start the local Data Ramen server |
|
|
62
|
+
| `dataramen stop` | Stop the local server |
|
|
63
|
+
| `dataramen logs` | Show logs from the running server |
|
|
64
|
+
|
|
65
|
+
## ❤️ Made with love by [Oleksandr Demian](https://github.com/OleksandrDemian)
|
|
66
|
+
|
|
67
|
+
Visit [dataramen.xyz](https://dataramen.xyz) for more info.
|
package/dist/README.md
ADDED
|
File without changes
|