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.

Metadata

Release files for kglite-cli 0.19.2

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.19.2
File
kglite_cli-0.19.2-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details
kglite_cli-0.19.2-py3-none-musllinux_1_2_x86_64.whl Python 3 none Linux musl 1.2+ x86-64 Details
kglite_cli-0.19.2-py3-none-musllinux_1_2_aarch64.whl Python 3 none Linux musl 1.2+ ARM64 Details
kglite_cli-0.19.2-py3-none-manylinux_2_28_aarch64.whl Python 3 none Linux glibc 2.28+ ARM64 Details
kglite_cli-0.19.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl Python 3 none Linux glibc 2.17+ x86-64 Details
kglite_cli-0.19.2-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details
kglite_cli-0.19.2-py3-none-macosx_10_12_x86_64.whl Python 3 none macOS 10.12+ x86-64 Details

Total release size: 53.4 MB

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

Download URL kglite_cli-0.19.2-py3-none-win_amd64.whl
Size 8.0 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
6d7e28091b45181f39b6bd8964beea38017cad2826a2f1d7aa4271c9a8c01655
BLAKE2b-256 checksum
How to use checksums
bdac6ca199883fdc08ef6cc278acbd8e931955828e77456c78f2d0f6bdd74dba
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 Oct 4, 2026.

Transparency log

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

Download URL kglite_cli-0.19.2-py3-none-musllinux_1_2_x86_64.whl
Size 8.0 MB
Tags Linux musl 1.2+ x86-64 Python 3
SHA-256 checksum
How to use checksums
2f4f7af13d61722d6902983d6a51e4faa92b7be3213ca7b4ff0980d23dd64214
BLAKE2b-256 checksum
How to use checksums
8dbc5040f4b2f378bc6c39615d0fa71471c3df8f99b4eab2f505ea1565613d9f
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 Oct 4, 2026.

Transparency log

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

Download URL kglite_cli-0.19.2-py3-none-musllinux_1_2_aarch64.whl
Size 7.3 MB
Tags Linux musl 1.2+ ARM64 Python 3
SHA-256 checksum
How to use checksums
26cf3d37b13f1ebbd86c7907b9e31210b44f6a6def277f063768bd41802828b0
BLAKE2b-256 checksum
How to use checksums
cc5c97e169aa79e6eb18e619825e987e8f0cd3ac5d7917c4185cf056c31a19a0
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 Oct 4, 2026.

Transparency log

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

Download URL kglite_cli-0.19.2-py3-none-manylinux_2_28_aarch64.whl
Size 7.3 MB
Tags Linux glibc 2.28+ ARM64 Python 3
SHA-256 checksum
How to use checksums
3902532e63792eea1134d81bc97c9aac5189d80a73b90c9ec601c17be9a8f837
BLAKE2b-256 checksum
How to use checksums
6d3fd42f76a01aa59b540e535e296bfa2f73d21b122d27697ca1f5df1abb05d1
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 Oct 4, 2026.

Transparency log

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

Download URL kglite_cli-0.19.2-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 7.9 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
a15e585a8a598ced4bb68f88a8716aea6a1a5b379fa949da2697b2c232104dce
BLAKE2b-256 checksum
How to use checksums
baa7c5a5d55585505773d3f35320f13f2624610115f4a50e112c9dfbca273f06
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 Oct 4, 2026.

Transparency log

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

Download URL kglite_cli-0.19.2-py3-none-macosx_11_0_arm64.whl
Size 7.1 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
2d8ea045a828eaf57a757e822d1a21711b193f3d99fd6f09cddca7cabb80f4b6
BLAKE2b-256 checksum
How to use checksums
bd7a53947b493f49b5659abd8c1b7e3fa0ba1aedc832ec8e4b46626bd6e29878
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 Oct 4, 2026.

Transparency log

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

Download URL kglite_cli-0.19.2-py3-none-macosx_10_12_x86_64.whl
Size 7.7 MB
Tags Python 3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
a4b6fd76b2859beb3359ee846157358d606378873e761af9e3cfed0df10bcc58
BLAKE2b-256 checksum
How to use checksums
f7bf882aeefc4a902ad7668ad1de4098a92e984e12db7f56659d8424df882edf
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 Oct 4, 2026.

Transparency log

Release history Release notifications | RSS feed

0.20.0

7 release files

0.19.7

7 release files

This release

0.19.2 This release

7 release files

0.19.0

7 release files

0.18.1

7 release files

0.18.0

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