schemalens 0.0.1 → 0.0.2
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 +49 -0
- package/package.json +4 -3
package/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# SchemaLens
|
|
2
|
+
|
|
3
|
+
A local-first developer tool that generates living architecture diagrams from your database schema. Point it at a database, and SchemaLens visualizes tables, columns, and foreign-key relationships on an interactive canvas.
|
|
4
|
+
|
|
5
|
+
Supports **PostgreSQL** and **SQLite**.
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- BFS crawl from any table to explore related tables up to a configurable depth
|
|
10
|
+
- Ghost nodes for references beyond the crawl boundary, expandable with a click
|
|
11
|
+
- Schema-aware navigation with cross-schema relationship tracking
|
|
12
|
+
- Schema diffing to see what changed between refreshes
|
|
13
|
+
- Workspace persistence so you can save and restore canvas layouts
|
|
14
|
+
- Runs entirely on your machine — no data leaves localhost
|
|
15
|
+
|
|
16
|
+
## Install
|
|
17
|
+
|
|
18
|
+
```
|
|
19
|
+
npm install -g schemalens
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Usage
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
schemalens
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
This starts a local server and opens the UI in your browser. Connect to a database from the interface.
|
|
29
|
+
|
|
30
|
+
Set a custom port with the `SCHEMALENS_PORT` environment variable:
|
|
31
|
+
|
|
32
|
+
```
|
|
33
|
+
SCHEMALENS_PORT=4000 schemalens
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Development
|
|
37
|
+
|
|
38
|
+
SchemaLens is a TypeScript monorepo using npm workspaces.
|
|
39
|
+
|
|
40
|
+
```
|
|
41
|
+
npm install
|
|
42
|
+
npm run dev
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
This starts the backend (port 3100) and Vite dev server (port 5173) concurrently.
|
|
46
|
+
|
|
47
|
+
## License
|
|
48
|
+
|
|
49
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,18 +1,19 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "schemalens",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"bin": {
|
|
6
6
|
"schemalens": "dist/index.js"
|
|
7
7
|
},
|
|
8
8
|
"files": [
|
|
9
9
|
"dist",
|
|
10
|
-
"ui"
|
|
10
|
+
"ui",
|
|
11
|
+
"README.md"
|
|
11
12
|
],
|
|
12
13
|
"scripts": {
|
|
13
14
|
"build": "node build.mjs",
|
|
14
15
|
"copy-ui": "rm -rf ui && cp -r ../ui/dist ui",
|
|
15
|
-
"prepublishOnly": "npm run build --workspaces && npm run build && npm run copy-ui"
|
|
16
|
+
"prepublishOnly": "npm run build --workspaces && npm run build && npm run copy-ui && cp ../../README.md ."
|
|
16
17
|
},
|
|
17
18
|
"dependencies": {
|
|
18
19
|
"better-sqlite3": "^11.0.0",
|