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 and .md 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.4.tar.gz (17.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.4-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_llm-0.1.4.tar.gz
  • Upload date:
  • Size: 17.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.4.tar.gz
Algorithm Hash digest
SHA256 98764bd04cafb50203f7b35b065859fb84217f1b02c244e6f647faced6007e12
MD5 204faa7ca1da59f0423b1a9ad28925af
BLAKE2b-256 6a24d31ed391663358ded09f0263c51e7ee9294c14031532e72fe34df1660201

See more details on using hashes here.

Provenance

The following attestation bundles were made for kestrel_llm-0.1.4.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.4-py3-none-any.whl.

File metadata

  • Download URL: kestrel_llm-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 17.5 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 623a27e78905e4b554f0fd25b9c8fdec3c36929e50ef57a33e4e38f2d1233718
MD5 3a11d150db4c53813c02c3e0f2b66ba7
BLAKE2b-256 6c2a5888de3c853cd5d82552063792048dafd717559ec41781bf53da1a37b30f

See more details on using hashes here.

Provenance

The following attestation bundles were made for kestrel_llm-0.1.4-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