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

Uploaded Python 3Windows x86-64

kglite_cli-0.13.3-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.3-py3-none-musllinux_1_2_aarch64.whl (4.1 MB view details)

Uploaded Python 3musllinux: musl 1.2+ ARM64

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

Uploaded Python 3manylinux: glibc 2.28+ ARM64

kglite_cli-0.13.3-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.3-py3-none-macosx_11_0_arm64.whl (3.9 MB view details)

Uploaded Python 3macOS 11.0+ ARM64

kglite_cli-0.13.3-py3-none-macosx_10_12_x86_64.whl (4.3 MB view details)

Uploaded Python 3macOS 10.12+ x86-64

File details

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

File metadata

  • Download URL: kglite_cli-0.13.3-py3-none-win_amd64.whl
  • Upload date:
  • Size: 4.3 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.3-py3-none-win_amd64.whl
Algorithm Hash digest
SHA256 445c82358306d0b02558095a735d7a4ff4b55f1e4d9750649d751bec05d5f40f
MD5 8898d192962f08941f210c0909fc16bc
BLAKE2b-256 4f1c6d78cb4a797476c9b4ba182b80d0657fcbed82b250665b9b34509af3767f

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.13.3-py3-none-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 37f73a5cdd8fbcc6ce4d592dd102ee82156463eabc51dccbb3b72519e410b05e
MD5 11c6829fc85926415273d37ec61d5d56
BLAKE2b-256 b2002b40fefb0549508e201e6eada7496bfe0308d79ae7d4b884acba0c3460a1

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.13.3-py3-none-musllinux_1_2_aarch64.whl
Algorithm Hash digest
SHA256 f5e54be445fbbab980491d8d6985185148913bd438d8df69c6097c8bff259613
MD5 977d8099af323dfa4abe4efbbff6cf5d
BLAKE2b-256 95874acbff2eba22b2ce0d5b5cadf6d5afda868f3ac523bb4087e81d9e38d499

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.13.3-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 629c0b99035bfd45cacfdf1fe5eba60676407bd497ccc1cfa43066c6f01c5d37
MD5 d64705b8208b7b4b38e5b61b7f1ed5c8
BLAKE2b-256 c6aeae5517be4eca79fdc2a8900a9f95f88e3a9577a6980d131b0eab000b8a11

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.13.3-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 fbd5205d4f6e7a35933079103b9c3833bc26595ab9abe759c23d5b3181f4fbad
MD5 3561dafcab0213c27633d6dfd933171b
BLAKE2b-256 febb4e967eef4b8b930624c6a579d0568544185041bad8376b0ec8e48d1c5ea7

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.13.3-py3-none-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 86eee36687b6d2cc3e047655e76f7a568989de01fd0cc151f7defac6b10e3c8f
MD5 867b05dc0d8130f10828e7582430be3e
BLAKE2b-256 d376ae62dd9bd537ae3984eb4b313a240dd9a508b17425ba3d166976562dff70

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for kglite_cli-0.13.3-py3-none-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 6c180425d675ee9f6e784f097b4fd46e66488ce9a5860d1df284529be4a5e4b3
MD5 216a501a543fde877f9c303aaed11a47
BLAKE2b-256 927c3805816a7c1b93823f6a3161d8351ab800d93bbddbf807a979c3a82828bb

See more details on using hashes here.

Provenance

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

This release

0.13.3 This release

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

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