@irongraph/cli-darwin-arm64 0.1.8 → 0.1.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 +1 -116
- package/bin/irongraph +2 -2
- package/bin/irongraph-mcp +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,127 +1,12 @@
|
|
|
1
1
|
# IronGraph
|
|
2
2
|
|
|
3
|
-
**
|
|
3
|
+
**Embeddable Cypher graph database with sub-µs point reads, built-in streams, queues, and local text embeddings. Standalone launcher.**
|
|
4
4
|
|
|
5
5
|
Use Cypher to query graph structure, search text and vectors, inspect property history, and
|
|
6
6
|
administer the database. Built-in Kafka-compatible Streams and AMQP-compatible Queues handle event
|
|
7
7
|
and message workloads. The `irongraph` CLI starts and manages a standalone database with its
|
|
8
8
|
built-in web console. IronGraph is open-source software released under the Apache License 2.0.
|
|
9
9
|
|
|
10
|
-
## Performance at a glance
|
|
11
|
-
|
|
12
|
-
Graph queries execute on the CPU against one shared canonical graph. Local text inference can
|
|
13
|
-
use Metal or CUDA independently. Measure complete queries separately from individual graph operations;
|
|
14
|
-
latency depends on the workload, graph size, indexes, and host.
|
|
15
|
-
|
|
16
|
-
## Start the database and open the web console
|
|
17
|
-
|
|
18
|
-
Use this path to run IronGraph as a standalone database with its built-in web console.
|
|
19
|
-
Python, Node.js, and Rust embedding are separate options described below.
|
|
20
|
-
|
|
21
|
-
### 1. Check the prerequisites
|
|
22
|
-
|
|
23
|
-
You need Node.js 20.17 or later with npm, and an official `irongraph` release available on npm
|
|
24
|
-
for your platform: macOS 15+ ARM64, or Linux ARM64/AMD64 with glibc 2.28+. Before the first
|
|
25
|
-
official publication, these npm commands are not an available installation channel.
|
|
26
|
-
|
|
27
|
-
Use a writable local data directory owned exclusively by this database process. First startup
|
|
28
|
-
also needs network access and several gigabytes of free storage for the automatically installed
|
|
29
|
-
local text embedding model. The launcher selects a compiled database binary with the web console
|
|
30
|
-
included. You do not need Python, a Rust compiler, or a separate frontend server.
|
|
31
|
-
|
|
32
|
-
### 2. Start IronGraph
|
|
33
|
-
|
|
34
|
-
Run this command to install the matching package as needed and start in the background:
|
|
35
|
-
|
|
36
|
-
```sh
|
|
37
|
-
npx irongraph start --background
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
Your data lives in `~/.irongraph/data`. The database keeps running after you close the terminal.
|
|
41
|
-
Wait for startup and the embedding model's installation, loading, and warm-up to finish. Check
|
|
42
|
-
progress and readiness with:
|
|
43
|
-
|
|
44
|
-
```sh
|
|
45
|
-
npx irongraph logs
|
|
46
|
-
npx irongraph status
|
|
47
|
-
```
|
|
48
|
-
|
|
49
|
-
Graph execution uses the CPU. Text inference selects its device independently: automatic selection
|
|
50
|
-
prefers a supported GPU and falls back to the CPU when no usable GPU is available. You can select
|
|
51
|
-
CPU inference explicitly with `--embedding-backend cpu`. To run in the
|
|
52
|
-
foreground with live terminal output, use `npx irongraph start` without `--background`.
|
|
53
|
-
|
|
54
|
-
### 3. Open the web console
|
|
55
|
-
|
|
56
|
-
When status reports **ready**, open **[http://127.0.0.1:18484/web/](http://127.0.0.1:18484/web/)**
|
|
57
|
-
in a browser on the same computer.
|
|
58
|
-
This address belongs to your running local instance. The product website at
|
|
59
|
-
The public project page is not your database console.
|
|
60
|
-
|
|
61
|
-
The console provides Query, Streams, Documents (for text documents), Training, Docs, and
|
|
62
|
-
Settings. The graph visualization is the Plot result view inside Query.
|
|
63
|
-
|
|
64
|
-
### 4. Create your first project
|
|
65
|
-
|
|
66
|
-
Click **New** in the top bar, enter `notes`, and click **Create project**. The console selects
|
|
67
|
-
your new project. In **Query**, replace the editor contents with:
|
|
68
|
-
|
|
69
|
-
```cypher
|
|
70
|
-
USE notes
|
|
71
|
-
RETURN 'IronGraph is ready' AS status
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
Click **Run**, then select the **Table** result view. Expected result: a `status` column
|
|
75
|
-
containing `IronGraph is ready`. Every graph operation needs
|
|
76
|
-
an explicit project; IronGraph has no implicit default project. Next, open **Documents** to work
|
|
77
|
-
with text documents in your project, or continue in Query to create nodes and relationships.
|
|
78
|
-
|
|
79
|
-
### 5. Stop and restart
|
|
80
|
-
|
|
81
|
-
For a background instance, run:
|
|
82
|
-
|
|
83
|
-
```sh
|
|
84
|
-
npx irongraph stop
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
For a foreground instance, press `Ctrl+C` and wait for the process to exit. Start again with
|
|
88
|
-
`npx irongraph start --background` to reopen the same data directory. Your data persists between
|
|
89
|
-
runs. Background mode does not install a system service or restart the database after a reboot.
|
|
90
|
-
|
|
91
|
-
### Configuration and direct binary use
|
|
92
|
-
|
|
93
|
-
Choose another directory with `--data-dir /absolute/path`. Pass the same directory to `status`,
|
|
94
|
-
`logs`, and `stop`. A second start cannot open a second managed instance on that directory.
|
|
95
|
-
|
|
96
|
-
Local listener defaults are consistent across development and releases:
|
|
97
|
-
|
|
98
|
-
| Surface | Loopback port |
|
|
99
|
-
| --- | --- |
|
|
100
|
-
| Web console and Query API | `18484` |
|
|
101
|
-
| Bolt | `18485` |
|
|
102
|
-
| Kafka-compatible Streams | `18486` |
|
|
103
|
-
| AMQP-compatible Queues | `18487` |
|
|
104
|
-
| Local MCP HTTP | `18488` |
|
|
105
|
-
|
|
106
|
-
The frontend development server uses `18489`; the standalone console is always served by the
|
|
107
|
-
database's HTTP listener. Embedded libraries do not start these listeners.
|
|
108
|
-
|
|
109
|
-
If the console does not open, check that the process is still running and startup completed.
|
|
110
|
-
If port `18484` is already occupied, start with `--http-addr 127.0.0.1:19484` and open
|
|
111
|
-
`http://127.0.0.1:19484/web/` instead. Keep plain listeners on loopback; access from another
|
|
112
|
-
computer requires a configured remote listener with mutual TLS.
|
|
113
|
-
|
|
114
|
-
You can also extract the matching official standalone archive and run its executable directly,
|
|
115
|
-
without Node.js or npm:
|
|
116
|
-
|
|
117
|
-
```sh
|
|
118
|
-
./bin/irongraph --data-dir "$HOME/.irongraph/data" --http-addr 127.0.0.1:18484
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
Direct execution runs in the foreground. Stop it with `Ctrl+C`; launcher commands manage only
|
|
122
|
-
instances started through the launcher. The archive also includes `bin/irongraph-mcp` for local
|
|
123
|
-
stdio MCP hosts.
|
|
124
|
-
|
|
125
10
|
## Database capabilities
|
|
126
11
|
|
|
127
12
|
| Capability | What you can do |
|
package/bin/irongraph
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
[diffend] Oversized file quarantined before diffing.
|
|
2
2
|
name: package/bin/irongraph
|
|
3
|
-
size:
|
|
4
|
-
sha256:
|
|
3
|
+
size: 56908336 bytes
|
|
4
|
+
sha256: d766bafaa1f779125c97c87ae7bdcdb34591752d3134cec9789651e43ec2d935
|
package/bin/irongraph-mcp
CHANGED
|
Binary file
|
package/package.json
CHANGED