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.13.0-py3-none-win_amd64.whl (4.2 MB view details)

Uploaded Python 3Windows x86-64

kglite_cli-0.13.0-py3-none-musllinux_1_2_x86_64.whl (4.5 MB view details)

Uploaded Python 3musllinux: musl 1.2+ x86-64

kglite_cli-0.13.0-py3-none-musllinux_1_2_aarch64.whl (4.0 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARM64

kglite_cli-0.13.0-py3-none-manylinux_2_28_aarch64.whl (4.0 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ ARM64

kglite_cli-0.13.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.4 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

kglite_cli-0.13.0-py3-none-macosx_11_0_arm64.whl (3.8 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

kglite_cli-0.13.0-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.13.0-py3-none-win_amd64.whl.

File metadata

  • Download URL: kglite_cli-0.13.0-py3-none-win_amd64.whl
  • Upload date:
  • Size: 4.2 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.13.0-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 cbed53da0cb223f7ab5b519d1651f747f81824d1000f785332b6212f5cba817c
MD5 4d8436acfdcd64ef10e0979668b7d933
BLAKE2b-256 070d37fcc25531501a61b600ae67de74fe9c5fc8c135ae82b49dd5e5479a3499

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.13.0-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.13.0-py3-none-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for kglite_cli-0.13.0-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 82d33d61cf1ce0e8daa8c417aee267b8f303dcc0fe65506ca881afe407ecd585
MD5 fa635c9d27571605694cc0db766b4e51
BLAKE2b-256 ab49031f491b1e833e4ea4819e243a6261e1d8d4b87888217abe66360f6cbbb4

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.13.0-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.13.0-py3-none-musllinux_1_2_aarch64.whl.

File metadata

File hashes

Hashes for kglite_cli-0.13.0-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 da786175ccc607436b5c57ad5a9a00d652c7427094a52aa4a3285a59de7ac725
MD5 7cc314b7f9e073b2b54e5f373603ee09
BLAKE2b-256 599b5752d07c3b0bf12158f2121bb3fec44cd8541a4669df34d619598c809a29

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.13.0-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.13.0-py3-none-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for kglite_cli-0.13.0-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 1374cbb0d24c064173b33e40eac936789563d2299f71c001d6978aa02c949df0
MD5 d2829839c07364d804eee026147e5d5e
BLAKE2b-256 9bcd142b63acc8a8f58fbf59081aa01a62f0d6dd1af30502675ef5383af58b9d

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.13.0-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.13.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for kglite_cli-0.13.0-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 64735d78baa8eb21dcca539f3f6de27245b74cad509588c9a2256d147908c70d
MD5 18b28d325cde82fc54f57a97bf654289
BLAKE2b-256 32adb73f68b5f07048b2c24eeed4c73aa2b0892708349feda9b0cee896f6a8a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.13.0-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.13.0-py3-none-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for kglite_cli-0.13.0-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 0fd6e6b9787b02f4c78ec8adfad788b619aeebc639e884f7afde4b2f9c2472e4
MD5 f0a81466869acb90adfc0711baf9feb2
BLAKE2b-256 e24b19f47f79718a4439bda23980d04d86330ec270d260c231e7a6be3c05089c

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.13.0-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.13.0-py3-none-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for kglite_cli-0.13.0-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 8560b1c00dfeeb218173e0d09a71ccc5050f0bde659263116ddb0526bf69982e
MD5 886e047b8ed8fe57b2b6beaba2f26387
BLAKE2b-256 20f0336833c85174df83dda9900e734183b85363b48d30f7d4e2b929dfb35fb0

See more details on using hashes here.

Provenance

The following attestation bundles were made for kglite_cli-0.13.0-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

This release

0.13.0 This release

7 files

0.12.14

7 files

0.12.13

7 files

0.12.12

7 files

0.12.11

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