sql-kite 1.0.1 → 1.0.3
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 +46 -19
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -140,6 +140,22 @@ A clean local interface for:
|
|
|
140
140
|
|
|
141
141
|
---
|
|
142
142
|
|
|
143
|
+
## Screenshots
|
|
144
|
+
|
|
145
|
+
### SQL Editor
|
|
146
|
+
|
|
147
|
+
Execute queries, save templates, and export results with full SQL syntax highlighting.
|
|
148
|
+
|
|
149
|
+

|
|
150
|
+
|
|
151
|
+
### Database Schema Viewer
|
|
152
|
+
|
|
153
|
+
Browse tables, inspect columns, constraints, indexes, and relationships in a clean interface.
|
|
154
|
+
|
|
155
|
+

|
|
156
|
+
|
|
157
|
+
---
|
|
158
|
+
|
|
143
159
|
## Zero-Cloud Architecture
|
|
144
160
|
|
|
145
161
|
SQL Kite runs **entirely on your machine**.
|
|
@@ -163,12 +179,23 @@ SQL Kite runs **entirely on your machine**.
|
|
|
163
179
|
* Node.js 18+
|
|
164
180
|
* npm
|
|
165
181
|
|
|
166
|
-
### Install
|
|
182
|
+
### Install Globally (Recommended)
|
|
183
|
+
|
|
184
|
+
Install SQL Kite globally to use it from anywhere:
|
|
167
185
|
|
|
168
186
|
```bash
|
|
169
187
|
npm install -g sql-kite
|
|
170
188
|
```
|
|
171
189
|
|
|
190
|
+
After installation, you can use `sql-kite` commands directly:
|
|
191
|
+
|
|
192
|
+
```bash
|
|
193
|
+
sql-kite new my-db
|
|
194
|
+
sql-kite start my-db
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
> **Note:** Use global installation (`-g` flag) for CLI tools. After installing globally, run commands directly as `sql-kite <command>`, not `npm run sql-kite <command>`.
|
|
198
|
+
|
|
172
199
|
---
|
|
173
200
|
|
|
174
201
|
<a name="quick-start"></a>
|
|
@@ -178,13 +205,13 @@ npm install -g sql-kite
|
|
|
178
205
|
### 1) Create a project
|
|
179
206
|
|
|
180
207
|
```bash
|
|
181
|
-
|
|
208
|
+
sql-kite new my-db
|
|
182
209
|
```
|
|
183
210
|
|
|
184
211
|
### 2) Start the studio
|
|
185
212
|
|
|
186
213
|
```bash
|
|
187
|
-
|
|
214
|
+
sql-kite start my-db
|
|
188
215
|
```
|
|
189
216
|
|
|
190
217
|
Your browser opens automatically.
|
|
@@ -194,7 +221,7 @@ Your browser opens automatically.
|
|
|
194
221
|
### Import an existing database
|
|
195
222
|
|
|
196
223
|
```bash
|
|
197
|
-
|
|
224
|
+
sql-kite import ./database.db
|
|
198
225
|
```
|
|
199
226
|
|
|
200
227
|
> SQL Kite will safely adopt the file into a managed workspace.
|
|
@@ -203,17 +230,17 @@ npm run sql-kite import ./database.db
|
|
|
203
230
|
|
|
204
231
|
## CLI Commands
|
|
205
232
|
|
|
206
|
-
| Command
|
|
207
|
-
|
|
|
208
|
-
| `
|
|
209
|
-
| `
|
|
210
|
-
| `
|
|
211
|
-
| `
|
|
212
|
-
| `
|
|
213
|
-
| `
|
|
214
|
-
| `
|
|
215
|
-
| `
|
|
216
|
-
| `
|
|
233
|
+
| Command | Description |
|
|
234
|
+
| ---------------------------| ----------------------------|
|
|
235
|
+
| `sql-kite import <path>` | Import database |
|
|
236
|
+
| `sql-kite start <name>` | Launch Studio |
|
|
237
|
+
| `sql-kite stop <name>` | Stop server |
|
|
238
|
+
| `sql-kite open <name>` | Open UI |
|
|
239
|
+
| `sql-kite list` | List projects |
|
|
240
|
+
| `sql-kite new <name>` | Create project |
|
|
241
|
+
| `sql-kite delete <name>` | Remove project |
|
|
242
|
+
| `sql-kite ports` | Show port usage |
|
|
243
|
+
| `sql-kite init` | Scaffold app database layer |
|
|
217
244
|
|
|
218
245
|
---
|
|
219
246
|
|
|
@@ -227,7 +254,7 @@ SQL Kite provides a database integration layer with automatic dev/production swi
|
|
|
227
254
|
|
|
228
255
|
```bash
|
|
229
256
|
cd your-app-project
|
|
230
|
-
|
|
257
|
+
sql-kite init
|
|
231
258
|
```
|
|
232
259
|
|
|
233
260
|
This creates:
|
|
@@ -385,14 +412,14 @@ npm run build:studio
|
|
|
385
412
|
### Port in use
|
|
386
413
|
|
|
387
414
|
```bash
|
|
388
|
-
|
|
415
|
+
sql-kite ports
|
|
389
416
|
```
|
|
390
417
|
|
|
391
418
|
### Restart project
|
|
392
419
|
|
|
393
420
|
```bash
|
|
394
|
-
|
|
395
|
-
|
|
421
|
+
sql-kite stop my-db
|
|
422
|
+
sql-kite start my-db
|
|
396
423
|
```
|
|
397
424
|
|
|
398
425
|
### Import fails
|
package/package.json
CHANGED
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sql-kite",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.3",
|
|
4
4
|
"description": "SQL-Kite CLI — Local-first SQLite workspace with branches, migrations and snapshots.",
|
|
5
5
|
"type": "module",
|
|
6
|
+
"preferGlobal": true,
|
|
6
7
|
"bin": {
|
|
7
8
|
"sql-kite": "./bin/sql-kite.js"
|
|
8
9
|
},
|