Skip to main content

Utilities to verify and maintain LLM.txt files (coverage, sorting, symbols blocks).

Project description

Kestrel-llm Tool

Small, dependency-free utilities for maintaining an LLM.txt file in a repo. The LLM.txt contains a description about each file and line number for every class and function.

Checkout the LLM.txt for this project!

Install

From this repo:

python -m pip install -e .

From PyPI:

python -m pip install kestrel-llm

Commands

Run these from any directory inside a repo that contains LLM.txt (or llm.txt) somewhere above your current working directory.

  • llm-check: verify LLM.txt covers all .py files, enforces exactly two-sentence summaries, and enforces alphabetical sorting of both section headers and entries.
  • llm-fix: sort sections/entries in LLM.txt and refresh Symbols: blocks.
  • llm-sync: sort, strictly verify, refresh Symbols: blocks, then strictly verify again.

Common options

  • --repo-root PATH: override the repo root used for scanning.
  • --llm-file PATH: override the LLM.txt path.
  • --exclude-dir NAME: exclude additional directory names when scanning (repeatable).
  • --log-level LEVEL: set logging level (or use LOG_LEVEL env var).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kestrel_llm-0.1.2.tar.gz (16.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kestrel_llm-0.1.2-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

Details for the file kestrel_llm-0.1.2.tar.gz.

File metadata

  • Download URL: kestrel_llm-0.1.2.tar.gz
  • Upload date:
  • Size: 16.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kestrel_llm-0.1.2.tar.gz
Algorithm Hash digest
SHA256 1ef3841b5ec1bfdf5874cb4aecc568db1d737ff587d618da3ba5ee59cb84dcd8
MD5 5b75b0d239a3fd8ea72e4eee2f837523
BLAKE2b-256 ad5e11b1b41027b8a10533e72abadf0606bfac0f4224438bab3f0dd8da4762d8

See more details on using hashes here.

Provenance

The following attestation bundles were made for kestrel_llm-0.1.2.tar.gz:

Publisher: publish.yml on gdevos010/kestrel-llm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file kestrel_llm-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: kestrel_llm-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 17.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for kestrel_llm-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b34449e04fdd7946b1436162857b36c3c3da67ad6d12246403601b78a965b0dc
MD5 7f30951444b009c67aa4b77f9dfc50ed
BLAKE2b-256 ef3b6488ec58ae76a0f3a854c81c20a181d5bee8ea900cbc16368909f775d9dd

See more details on using hashes here.

Provenance

The following attestation bundles were made for kestrel_llm-0.1.2-py3-none-any.whl:

Publisher: publish.yml on gdevos010/kestrel-llm

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page