Skip to main content

kglite-cli

The interactive Cypher shell for kglite knowledge graphs — the sqlite3-style REPL for .kgl files.

Install

$ pip install kglite-cli      # ships the `kglite` binary on PATH
# or
$ cargo install kglite-cli    # build from source (needs a Rust toolchain)

kglite-cli is a standalone binary distribution — installing it gives you the kglite command. It's independent of the kglite Python library; install either or both.

Use

Run one query and exit:

$ kglite query app.kgl "MATCH (n:Person) RETURN n.name AS name" --format json
[
  {
    "name": "Alice"
  }
]

Run a scoped write and persist it:

$ kglite write app.kgl "CREATE (:Task {id:'t1', status:'todo'})" \
    --save --write-scope Task --git-sha abc123 --modified-by agent

Inspect a dependency frontier:

$ kglite ready-set app.kgl --done 'n.status = "done"' --node-type Task --format csv

Ask for the agent-oriented graph description:

$ kglite describe app.kgl
$ kglite describe app.kgl --types Task
$ kglite describe app.kgl --cypher

Keep one graph loaded for an agent loop:

$ kglite session app.kgl --format json
{"op":"describe","types":["Task"]}
{"id":"w1","op":"write","query":"CREATE (:Task {id:'t1', status:'todo'})"}
{"id":"q1","op":"query","query":"MATCH (t:Task) RETURN count(t) AS n","format":"json"}
{"op":"save"}
{"op":"exit"}

Session JSON responses echo id when provided. JSON-mode query/write responses return typed rows; table/csv modes return rendered output. For describe, the compact forms still work ("connections":true, "connections":["KNOWS"]), and agents can use explicit object forms: "connections":{"detail":"overview"} or "connections":{"types":["KNOWS"]}.

Or open the interactive shell:

$ kglite app.kgl
kglite shell — app.kgl
Type .help for commands, .quit to exit.
kglite> MATCH (n:Person) RETURN n.name AS name LIMIT 3;
name
----
Alice
Bob
Carol
(3 rows)
kglite> .quit

Run with no path for a scratch in-memory graph ($ kglite). Pure-Rust single binary over kglite::api::* — no Python, no server.

A Cypher statement runs when terminated by ;, so it can span multiple lines; dot-commands run on Enter. Tab completes dot-commands and the graph's labels.

Commands

Non-interactive commands:

  • query <graph.kgl> <cypher> [--format table|csv|json] — run a read-only Cypher query
  • write <graph.kgl> <cypher> [--format table|csv|json] [--save] — run a write-capable Cypher statement
  • write --write-scope A,B --git-sha <sha> --modified-by <actor> — restrict writes and stamp provenance on auto_timestamp types
  • ready-set <graph.kgl> --done <predicate> [--relationship DEPENDS_ON] [--node-type T] — print CALL ready_set(...)
  • describe <graph.kgl> [--types T] [--cypher] [--connections] — print the XML describe() document for agents
  • session <graph.kgl> — process JSONL requests against one in-memory graph (query, write, describe, save, exit)
  • export-text <graph.kgl> — print the deterministic text projection used by git textconv
  • diff <a.kgl> <b.kgl> — compare two graph text projections

Interactive dot-commands:

  • .help — list commands
  • .quit / .exit — leave the shell
  • .labels / .rels / .schema / .indexes — schema introspection
  • .mode table|csv|json — set the output format
  • .import <file.csv> <NodeType> [--id <col>] [--title <col>] — load a CSV as nodes
  • .dump <dir> — export a portable CSV + blueprint.json copy (reload with kglite.from_blueprint(...))
  • .read <file> — run the Cypher statements in a file
  • .save [path] — write the graph to a .kgl file
  • .timing on|off — show query wall-time after each statement

Anything else is executed as Cypher. Ctrl-C cancels a running query; Ctrl-D exits.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

kglite_cli-0.12.11-py3-none-win_amd64.whl (4.1 MB view details)

Uploaded Python 3Windows x86-64

kglite_cli-0.12.11-py3-none-musllinux_1_2_x86_64.whl (4.4 MB view details)

Uploaded Python 3musllinux: musl 1.2+ x86-64

kglite_cli-0.12.11-py3-none-musllinux_1_2_aarch64.whl (3.9 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARM64

kglite_cli-0.12.11-py3-none-manylinux_2_28_aarch64.whl (3.9 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ ARM64

kglite_cli-0.12.11-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.3 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

kglite_cli-0.12.11-py3-none-macosx_11_0_arm64.whl (3.7 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

kglite_cli-0.12.11-py3-none-macosx_10_12_x86_64.whl (4.2 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

Details for the file kglite_cli-0.12.11-py3-none-win_amd64.whl.

File metadata

  • Download URL: kglite_cli-0.12.11-py3-none-win_amd64.whl
  • Upload date:
  • Size: 4.1 MB
  • Tags: Python 3, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for kglite_cli-0.12.11-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 662cb00f306eba41bbb194618c60856c0451a0a0995348a0e59832cb7d04bb70
MD5 0d57dd4caf6a7fccd0a8155d0e486272
BLAKE2b-256 930673beceb08a0dbb1e2f56d58ba26d5e81c648f2e00e85e121409ac46bb721

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.12.11-py3-none-win_amd64.whl:

Publisher: build_cli_wheels.yml on kkollsga/kglite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kglite_cli-0.12.11-py3-none-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for kglite_cli-0.12.11-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 216e428b06b92a03bcb1a802a0971cbd21798a4ad1cf69bf26c02053e1b8aca4
MD5 977a78711d91a8bb5bab58eff0b90b91
BLAKE2b-256 c388fea0f6c39bf261f127b6139f44c765898814509387cb513fcccf60dc42c2

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.12.11-py3-none-musllinux_1_2_x86_64.whl:

Publisher: build_cli_wheels.yml on kkollsga/kglite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kglite_cli-0.12.11-py3-none-musllinux_1_2_aarch64.whl.

File metadata

File hashes

Hashes for kglite_cli-0.12.11-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 b77631711af480aab3ce8ade988cd97db4f6786886b68d350d8acee746c43f60
MD5 ece27c4d064f4e54acc162298162ddd1
BLAKE2b-256 0ff53f0cb6aa6eafe21f309232886d43f6de1d60e0e394f6e868611516143115

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.12.11-py3-none-musllinux_1_2_aarch64.whl:

Publisher: build_cli_wheels.yml on kkollsga/kglite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kglite_cli-0.12.11-py3-none-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for kglite_cli-0.12.11-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 4c4129e8537a993997b21b2c642f37952410edc50f960b0a920c121af9092551
MD5 46bfda4691e62ad6a0af102c47e03ca8
BLAKE2b-256 27ce2911df4490b64f4d8cd727345d5a06d9925f93e509192d59bd2061418027

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.12.11-py3-none-manylinux_2_28_aarch64.whl:

Publisher: build_cli_wheels.yml on kkollsga/kglite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kglite_cli-0.12.11-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for kglite_cli-0.12.11-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 512c9e2c537e58b23ec3a7c1ea68fe3fcce9f809d2c7b0dc326d6f3e1378397f
MD5 5f637cde272e43e90dde6ad2e24c1f8a
BLAKE2b-256 9827d63ac8f295bbddd849b138883c8d4cbe0ee75d1e1bb0c36464c30a6d4ace

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.12.11-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: build_cli_wheels.yml on kkollsga/kglite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kglite_cli-0.12.11-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for kglite_cli-0.12.11-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 7d6ed17a94251c3275b58ae6aedc344ccd9cedd97f62abca8007d935122dbf0a
MD5 04b9bfa55bb97932b1afa3f5bf6e5d12
BLAKE2b-256 8a7954f1993678cd4d6e5b92318a96cd6477b1f652032bf60fb7b7cdf78b9ef6

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.12.11-py3-none-macosx_11_0_arm64.whl:

Publisher: build_cli_wheels.yml on kkollsga/kglite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kglite_cli-0.12.11-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for kglite_cli-0.12.11-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 e2075beaa7ec7e228bf08bf639fdaf465809bb0348b6daf7f81277058180c3b1
MD5 251e614bd23bed863f8e28f936aca594
BLAKE2b-256 df254ebc6c7b2b1fc85b8d5f1bfaaa8d5ffd8f5de810e06ab04d27e1fbfacd88

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.12.11-py3-none-macosx_10_12_x86_64.whl:

Publisher: build_cli_wheels.yml on kkollsga/kglite

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.16.23

7 files

0.16.22

7 files

0.16.21

7 files

0.16.20

7 files

0.16.19

7 files

0.16.18

7 files

0.16.17

7 files

0.16.16

7 files

0.16.15

7 files

0.16.14

7 files

0.16.13

7 files

0.16.12

7 files

0.16.11

7 files

0.16.10

7 files

0.16.9

7 files

0.16.8

7 files

0.16.7

7 files

0.16.6

7 files

0.16.5

7 files

0.16.4

7 files

0.16.3

7 files

0.16.2

7 files

0.16.1

7 files

0.16.0

7 files

0.15.14

7 files

0.15.13

7 files

0.15.12

7 files

0.15.11

7 files

0.15.10

7 files

0.15.9

7 files

0.15.8

7 files

0.15.7

7 files

0.15.6

7 files

0.15.5

7 files

0.15.4

7 files

0.15.3

7 files

0.15.2

7 files

0.15.1

7 files

0.15.0

7 files

0.14.5

7 files

0.14.4

7 files

0.14.3

7 files

0.14.2

7 files

0.14.1

7 files

0.14.0

7 files

0.13.4

7 files

0.13.3

7 files

0.13.2

7 files

0.13.1

7 files

0.13.0

7 files

0.12.14

7 files

0.12.13

7 files

0.12.12

7 files

This release

0.12.11 This release

7 files

0.12.10

7 files

0.12.9

7 files

0.12.8

7 files

0.12.7

7 files

0.12.6

7 files

0.12.5

7 files

0.12.4

7 files

0.12.3

7 files

0.12.2

7 files

0.12.1

7 files

0.12.0

7 files

0.11.16

7 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page