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          # Python API plus the `kglite` command
# or
$ pip install kglite-cli      # standalone CLI-only binary wheel
# or
$ cargo install kglite-cli    # standalone build (needs a Rust toolchain)

The main kglite wheel embeds this crate's Rust library and exposes the same command through a thin console-script shim. kglite-cli remains the standalone libpython-free binary distribution; install one route or the other.

The code-review Agent Skill is installed by codingest, which also builds the code graphs the skill queries:

$ codingest skill install

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

Build a code-review graph without Python or MCP configuration:

# Code-graph builds live in the codingest project's CLI:
$ codingest build . --output .kglite/code-review.kgl
$ codingest status --output .kglite/code-review.kgl

The adjacent metadata sidecar records the source and revision fingerprint so status can detect a stale working-tree artifact or a revision label that moved.

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.

Piped input (kglite app.kgl < script.cypher) additionally runs a balanced trailing statement at end of input and before a dot-command line, so a script whose last statement has no ; still runs; an unbalanced tail is reported on stderr with a non-zero exit. Table cells are width-capped only on a terminal.

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, including <skills> and <recipes> indexes when the graph carries them
  • skill <graph.kgl> [name] [--format table|csv|json] — list the skills the graph carries (sorted, --format honoured), or print one body raw on stdout. Read-only, no writer lease. Exits non-zero when the named skill is absent; a graph with no skills lists zero rows and exits 0. Skills and recipe queries are written from Python (set_skill / set_recipe), not here
  • okf check <dir> [--dialect obsidian|okf|loose] [--strict] [--json] — check a vault directory against the VAULT.md format and print the build report (counts, then errors, then warnings). Exits non-zero on any error; --strict counts warnings too. Runs the same read the build runs, so it reports what a build does
  • okf build <dir> -o <graph.kgl> [--dialect obsidian] — build a vault into a .kgl; the report goes to stderr, stdout names the file written
  • okf status <dir> [--graph <graph.kgl>] [--dialect obsidian] — print the vault's fingerprint (a stat pass; no note is read). With --graph, compare it against the one stamped in the .kgl at build time: current exits 0, stale exits non-zero. Keep the .kgl outside the vault — a file inside it is part of what the fingerprint covers
  • okf export <graph.kgl> <dir> [--force] [--source-root <dir>] — write a .kgl back out as a vault. Only files a previous export wrote are replaced or removed; anything else is refused, named on stderr and exits non-zero (--force lifts that). --source-root names the directory the graph's attachments were read from, so their bytes are copied too; omitted, the graph's own recorded source root stands in
  • session <graph.kgl> — process JSONL requests against one in-memory graph (query, write, describe, save, help, exit); {"op":"help"} returns the op table
  • 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.

Release files for kglite-cli 0.17.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for kglite-cli 0.17.10
File
kglite_cli-0.17.10-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details
kglite_cli-0.17.10-py3-none-musllinux_1_2_x86_64.whl Python 3 none Linux musl 1.2+ x86-64 Details
kglite_cli-0.17.10-py3-none-musllinux_1_2_aarch64.whl Python 3 none Linux musl 1.2+ ARM64 Details
kglite_cli-0.17.10-py3-none-manylinux_2_28_aarch64.whl Python 3 none Linux glibc 2.28+ ARM64 Details
kglite_cli-0.17.10-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl Python 3 none Linux glibc 2.17+ x86-64 Details
kglite_cli-0.17.10-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details
kglite_cli-0.17.10-py3-none-macosx_10_12_x86_64.whl Python 3 none macOS 10.12+ x86-64 Details

Total release size: 45.4 MB

Release files / kglite_cli-0.17.10-py3-none-win_amd64.whl

Download URL kglite_cli-0.17.10-py3-none-win_amd64.whl
Size 6.8 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
0783f0afae5cd8909a302e570a1bf0cec2d5e85746d604c6d4fc4b245a9d51de
BLAKE2b-256 checksum
How to use checksums
a92f275d296f0d90ff906b502a633e300667561c40dc543c81b3b710996c2fa2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 18, 2026.

Transparency log

Release files / kglite_cli-0.17.10-py3-none-musllinux_1_2_x86_64.whl

Download URL kglite_cli-0.17.10-py3-none-musllinux_1_2_x86_64.whl
Size 6.9 MB
Tags Linux musl 1.2+ x86-64 Python 3
SHA-256 checksum
How to use checksums
96733a96e1df3edc2fa53aa95f3a485c88fa4ed3e98c46093c726fe588cdb811
BLAKE2b-256 checksum
How to use checksums
eeaa8ca4bd4fbf1bbd21acad4bc05b45fbe5556ba468f73b29212febf8c5e31b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 18, 2026.

Transparency log

Release files / kglite_cli-0.17.10-py3-none-musllinux_1_2_aarch64.whl

Download URL kglite_cli-0.17.10-py3-none-musllinux_1_2_aarch64.whl
Size 6.2 MB
Tags Linux musl 1.2+ ARM64 Python 3
SHA-256 checksum
How to use checksums
6a14f588801e87b7e74dc411d2c069b41c91bef65ec6327101e3e5e3de6e86c1
BLAKE2b-256 checksum
How to use checksums
b75d046f4692e412d432fd218d9e514db3413517d6955f56c64c9912c296a5c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 18, 2026.

Transparency log

Release files / kglite_cli-0.17.10-py3-none-manylinux_2_28_aarch64.whl

Download URL kglite_cli-0.17.10-py3-none-manylinux_2_28_aarch64.whl
Size 6.2 MB
Tags Linux glibc 2.28+ ARM64 Python 3
SHA-256 checksum
How to use checksums
6edebe221e9a65f5fe1a9deb58c4b9cc9586b9e2d9ccbf7afa6fbe50f8b9df8d
BLAKE2b-256 checksum
How to use checksums
959d5b7ebc2156b4edf471d15d24b8ab75854eca4a655ca8908308b49313a787
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 18, 2026.

Transparency log

Release files / kglite_cli-0.17.10-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL kglite_cli-0.17.10-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 6.8 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
0bf4c550d046f2d421f1fcf90622643dcf64c16cbfbdba74192a79ee99ea428e
BLAKE2b-256 checksum
How to use checksums
6bb1f2443c936bbcb9bf0c42ba946746a36681dd6144ed9b89454eb0f24942ac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 18, 2026.

Transparency log

Release files / kglite_cli-0.17.10-py3-none-macosx_11_0_arm64.whl

Download URL kglite_cli-0.17.10-py3-none-macosx_11_0_arm64.whl
Size 6.0 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
1415810d5f02f21ebf7aabc1e95ad12478e9d376b1113ba1ddb4062e29c2a5fb
BLAKE2b-256 checksum
How to use checksums
82b3af9d5483e685481a155c37391e5ef3c96aacc2f3f03918f344d81c471c65
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 18, 2026.

Transparency log

Release files / kglite_cli-0.17.10-py3-none-macosx_10_12_x86_64.whl

Download URL kglite_cli-0.17.10-py3-none-macosx_10_12_x86_64.whl
Size 6.6 MB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
492103272d0487d8d63e795fc37f329f2ff3bb61c097c363b5e034947b811253
BLAKE2b-256 checksum
How to use checksums
98048288c0d1fff769d1472ec3d77c6667c4423a7183a3337fa87b73519a6c03
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 18, 2026.

Transparency log

Release history Release notifications | RSS feed

0.18.0

7 release files

This release

0.17.10 This release

7 release files

0.17.9

7 release files

0.17.8

7 release files

0.17.7

7 release files

0.17.6

7 release files

0.17.5

7 release files

0.17.4

7 release files

0.17.3

7 release files

0.16.9

7 release files

0.16.8

7 release files

0.16.7

7 release files

0.16.6

7 release files

0.16.5

7 release files

0.16.4

7 release files

0.16.3

7 release files

0.16.2

7 release files

0.16.1

7 release files

0.16.0

7 release files

0.15.9

7 release files

0.15.5

7 release files

0.15.4

7 release files

0.15.3

7 release files

0.15.2

7 release files

0.15.1

7 release files

0.15.0

7 release files

0.14.5

7 release files

0.14.4

7 release files

0.14.3

7 release files

0.14.2

7 release files

0.14.1

7 release files

0.14.0

7 release files

0.13.4

7 release files

0.13.3

7 release files

0.13.2

7 release files

0.13.1

7 release files

0.13.0

7 release files

0.12.4

7 release files

0.12.3

7 release files

0.12.2

7 release files

0.12.1

7 release files

0.12.0

7 release 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