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

Uploaded Python 3Windows x86-64

kglite_cli-0.12.14-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.14-py3-none-musllinux_1_2_aarch64.whl (3.9 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARM64

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

Uploaded Python 3manylinux: glibc 2.28+ ARM64

kglite_cli-0.12.14-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.14-py3-none-macosx_11_0_arm64.whl (3.7 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

kglite_cli-0.12.14-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.14-py3-none-win_amd64.whl.

File metadata

  • Download URL: kglite_cli-0.12.14-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.14-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 8b8df7b46b26b32230ca1e1eba53d843983f12befa72ef12ca2fffb2b3227d8f
MD5 7c8e87e917da9043d22ff6361d2ff1dd
BLAKE2b-256 bc5d53a8a8ac536cf12e5eb1055b11e4d037ebbf362e6c00bf860644d33c10f9

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.12.14-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 5267c6df814740ff9cc73a09eba7bfe54e13dca49d1cc708dc6228e2663cf7c9
MD5 ed6d54d0b76b313b84c1105dde7f8808
BLAKE2b-256 d0478a66b4a730b109978c0c0810157fd24fac3ac6360b278161d804ffeaa443

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.12.14-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 cb555c68c67852ac4b90b196d30fe3c1c4eec993de541a0a432eb2893d42e3a8
MD5 87fa22045bbfa585fef893bba9a312de
BLAKE2b-256 43cce91164a7ca17a39fab8528927e6f032b4674845fa4cd4537ebbfd9ea8960

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.12.14-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 02d10c903cb6c859cd81cfd676a93cbb891b6e2216db1138118b27127bebba11
MD5 071941bab6503aba538875a528d693bc
BLAKE2b-256 603ed21670f21b328c04486b17b1bd81c91a494e35411a1ca4c6098af7aaf29c

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.12.14-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 d8db7fad43b0a752a43610de042f972ab607959ad73571f9accfff20bfc5561a
MD5 c32bea5fc9fe35a05beb6264b5e2bc07
BLAKE2b-256 2a14bddf63892ede76dc7eb00188b450a68ffc62621bba45f4c5008037e59a82

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.12.14-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 1f17db7aebeb41c243d89300349e864e9b0a98488ba7e17d44e0df5831d298a7
MD5 18c35b62d465440c505b3a92a16cd50d
BLAKE2b-256 e2fec989470d84cbb8f613cb12066b6f9b20899aec72959896129915bebd87a3

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.12.14-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 665a95c4a030c2de901cd1830cf860de21ffaddaec5bbc8816faf843913f5de4
MD5 b73779d0fccc94aa061ae897fe18bd8b
BLAKE2b-256 314c9ef58e7df6e499771bc0b947d38d391065c3686b11aed41a91a3b0def83b

See more details on using hashes here.

Provenance

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

This release

0.12.14 This release

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