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.9

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

Total release size: 45.3 MB

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

Download URL kglite_cli-0.17.9-py3-none-win_amd64.whl
Size 6.8 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
7ac9cec83eef40272ba45a2d99ef4b447fa8794957b588e4c6d3dd6fd46edb86
BLAKE2b-256 checksum
How to use checksums
77098559cb6d8b7f40e2d46df5968692be0859263ad15661da60e5391d2fb05e
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.9-py3-none-musllinux_1_2_x86_64.whl

Download URL kglite_cli-0.17.9-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
ccd73bb1ddf79ca87d0c45cad37438cfded155cb28889c91ed40e02e38e2a419
BLAKE2b-256 checksum
How to use checksums
4fad8014b98c35852387b2deef6e4af9a3f413c50abe84610debad88c0b1f0bb
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.9-py3-none-musllinux_1_2_aarch64.whl

Download URL kglite_cli-0.17.9-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
09cc41830a4b59f8a36ff26fe5d86534233554755eb0706eec7684955c4b61f2
BLAKE2b-256 checksum
How to use checksums
e1d81b9d60cf5b948a543cde1807d9c81b2543790bd8ec70ca9b60fcaac38999
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.9-py3-none-manylinux_2_28_aarch64.whl

Download URL kglite_cli-0.17.9-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
3d0c52322518c938dbf6d36d664c1b4a357491970a981423ad33fc735dfec2f3
BLAKE2b-256 checksum
How to use checksums
89d27e3ba4f303e6cb650f28f997fa26f9c8dd962d92d99abf22cb7bd1305a6a
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.9-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL kglite_cli-0.17.9-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
ad643afc8932b2e1dc45efa68c3751232c9ef12f9b630a8d5caab70752845376
BLAKE2b-256 checksum
How to use checksums
e860dc59c5b8e41b16fd9ac05ed31016fc3ccbc0d7707910fa6a5779a6e837b1
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.9-py3-none-macosx_11_0_arm64.whl

Download URL kglite_cli-0.17.9-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
81ef53ee1b9cdc75120942c783401f5f1b18b6c91e28b1f0116f272c11fc0fff
BLAKE2b-256 checksum
How to use checksums
4a977d58af195b72797d1ecc2cee46d65b14862eb8f23787f49ccc3a488a7aed
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.9-py3-none-macosx_10_12_x86_64.whl

Download URL kglite_cli-0.17.9-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
9bef252950f8451cf067abd98005ccccdfcd01276b6367a0d32658a5e0362f24
BLAKE2b-256 checksum
How to use checksums
7c09791e1ddfeb1c416bd354ad0e9ae61c86a55cc80858c710e55f44fe651b5a
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.9 This release

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