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

Uploaded Python 3Windows x86-64

kglite_cli-0.12.13-py3-none-musllinux_1_2_x86_64.whl (4.3 MB view details)

Uploaded Python 3musllinux: musl 1.2+ x86-64

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

Uploaded Python 3musllinux: musl 1.2+ ARM64

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

Uploaded Python 3manylinux: glibc 2.28+ ARM64

kglite_cli-0.12.13-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.2 MB view details)

Uploaded Python 3manylinux: glibc 2.17+ x86-64

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

Uploaded Python 3macOS 11.0+ ARM64

kglite_cli-0.12.13-py3-none-macosx_10_12_x86_64.whl (4.1 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: kglite_cli-0.12.13-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.13-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 2bcb30024b104892743b4faba43d7349382cc9f8b3e2216c328a43d3697165c6
MD5 7ffe59164efada2d2994224b61fb6114
BLAKE2b-256 cc3b294ea9b707e0b39b9820ebc48e09774735d51f3fb05293502a08af2b388f

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.12.13-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 4e10acd18b6b17a6939de4990801e58e4732932c5e610b657a08c7e964cb720a
MD5 d1f94eac2e10b9100fe3261e21756c4c
BLAKE2b-256 27e1ce48b815b08a41faf19b4101ca851b779d87b663c326c2412c5e7288f6e9

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.12.13-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 fb21c12581bbc4d2dd4803f4c3f3984a7920b4b0c9a79f89b2e4517aa6fb84f7
MD5 ec3cc77940c5a0b20ae5332c30d96434
BLAKE2b-256 7b5b36a452ba77ce10f297b5da7ec61e1d22cd11b7dce8e43fe6c7ab1b37be2e

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.12.13-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 66a652444db8738a5d8e5dee77e92523520ce344859fa9ad85d22c585fe24e27
MD5 f7c544a52decbbcf136dd85685e85b9c
BLAKE2b-256 e73babb0a72671061bbb9b118ee1fcd8c5ba5f7fb3e822af5f9f45c0ad401e79

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.12.13-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 51866c42129b84ef2280113e6222b2fb1319d917988f7542334410d1e421f8d7
MD5 b2509811f3436074acd6fea684c76a33
BLAKE2b-256 718a99844f55da3abcc24379486be70fc72e3fe04aa10940599d75cffc02053a

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.12.13-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 25ae11966beb646793f600437f88162f75f804a7ab027f73705576c892f7d9ea
MD5 7b916d3c80f2d66c353d874e34226030
BLAKE2b-256 4cd9a083738cf994e329a8b9f8b045d8b70e19a273c9afea8131ed5c56a8d9d6

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.12.13-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 762d6028a505760f0a868989c79f6d0684cc04bb3da1e43322f8f7d87c3083f8
MD5 41c50af0a52d15ad82f08d83919c642f
BLAKE2b-256 b402bcd888a5428ad632f6fe6c4ac987d2cd584bc1de13eba9cdee9ab960446e

See more details on using hashes here.

Provenance

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

This release

0.12.13 This release

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