Add llms.txt for LLM/agent-readable project summary - #903
Open
abyworkings-coder wants to merge 1 commit into
Open
Add llms.txt for LLM/agent-readable project summary#903abyworkings-coder wants to merge 1 commit into
abyworkings-coder wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This repo doesn't have an
llms.txtfile yet — a small, curated markdown index (title, one-line summary, and grouped links to the docs that matter) that AI coding agents can read to understand a project quickly, instead of having to crawl and guess through the full README and wiki.buku has one of the densest CLI surfaces of any tool I looked at for this — dozens of flags across general, edit, search, encryption, and "power toy" categories, plus a separate prompt-mode key reference and a whole second product (bukuserver) living in a subdirectory. An agent trying to help someone construct a non-trivial
bukusearch or export command benefits a lot from being pointed straight at the right section instead of parsing the entire 600+ line README.Content is derived entirely from your existing docs (README sections: Installation, Quickstart, Command-line options, Examples, Automation, Shell completion, Related projects, plus the
bukuserver/README.md) — no new claims, just pointers. Validated against the llms.txt spec with llms-txt-lint (disclosure: a small validator tool I maintain — happy to drop that line from the PR if you'd rather not have it).Totally understand if this isn't something you want to maintain — no worries either way, feel free to close.