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.3.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.3-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kestrel_llm-0.1.3.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.3.tar.gz
Algorithm Hash digest
SHA256 9845a80ba0b8790a1dbc5ef9fd53c60493c7318f4e57e1cbe5ad828b83c6fb74
MD5 d9ba2d8c219e5919b895d43f83fe7305
BLAKE2b-256 40b76b9327e1f4ad9812303a84d5fc2752bffed58197962a541a186ef592b316

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: kestrel_llm-0.1.3-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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 07c8ae48ade6d598f369626121c96a59da87a7fed91814a1d91d17ff10377239
MD5 162dc2346ef5144d8647440f711d4ed3
BLAKE2b-256 d58aec6e4585195bee7cf38ad729b83d12b99ef6c4770af04d1c5dce9df403f9

See more details on using hashes here.

Provenance

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