sqlitegraph-cli

Command-line interface for SQLiteGraph graph database.

Installation

cargo install sqlitegraph-cli

Or install from source:

git clone https://github.com/oldnordic/sqlitegraph
cd sqlitegraph/sqlitegraph-cli
cargo install --path .

Quick Start

# Query using Cypher-like syntax (read-only by default)
sqlitegraph --db mygraph.db query "MATCH (n:User) RETURN n.name"

# Run graph algorithms
sqlitegraph --db mygraph.db bfs --start 1 --max-depth 3
sqlitegraph --db mygraph.db pagerank --iterations 100

# Insert data (requires --write flag)
sqlitegraph --db mygraph.db --write insert --kind User --name Alice

Backend Selection

SQLite Backend (Default)

• Mature, ACID-compliant storage
• Debuggable with standard SQL tools
• Best for point lookups

sqlitegraph --backend sqlite --db mygraph.db [command]

Native V3 Backend

• 10-20× faster traversals
• Unlimited node capacity
• Binary format for graph workloads

sqlitegraph --backend v3 --db mygraph.db [command]

Commands

Query Commands (Read-Only)

# Cypher-like queries
sqlitegraph query "MATCH (n:User) RETURN n.name"
sqlitegraph query "MATCH (n {role: 'admin'}) RETURN n"

# Graph traversal
sqlitegraph bfs --start 1 --max-depth 3
sqlitegraph path --from 1 --to 10
sqlitegraph neighbors --id 5 --direction outgoing

# Algorithms
sqlitegraph algo pagerank --iterations 100
sqlitegraph algo betweenness
sqlitegraph algo components

Data Modification (Requires --write)

# Insert nodes
sqlitegraph --write insert --kind User --name Alice

# Import/Export
sqlitegraph --write export --output graph.json
sqlitegraph --write import --input graph.json

Status

sqlitegraph status
sqlitegraph list
sqlitegraph list --kind User

Read-Only by Default

The CLI is read-only by default for safety. Use --write flag to enable modifications:

# This will fail (tries to modify without --write)
sqlitegraph --db graph.db insert --kind User --name Alice

# This works
sqlitegraph --db graph.db --write insert --kind User --name Alice

Ecosystem

This CLI is part of the SQLiteGraph ecosystem:

License

GPL-3.0-or-later