docs: add agent skill and tql reference documentation for treemd - #61
Merged
Conversation
Contributor
|
@wei840222 thanks for taking the time to put this together, it's a great addition to treemd. Most people don't realize how valuable treemd can be with AI agents - particularly for large markdown files. I may add a note to the readme |
Contributor
Author
|
Thank you. |
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
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.
Summary
This PR adds an AI Agent Skill specification and a concise
tql(treemd query language) reference guide under theskills/treemd/directory.As LLM-based coding agents and automation workflows increasingly rely on CLI tools to navigate large markdown files, having an explicit skill definition enables agents to use
treemdefficiently for structural inspection and target extraction without loading entire files into LLM context.Changes Included
--tree/--count/-l, locate--filter, extract-s) and query navigation (tql).-s, stdout/stdin streaming,--query-outputoptions, integration patterns (jqpipeline usage), and error handling exit codes..h,.code,.link), filters, hierarchy operators (>,>>), collection/string/filter/aggregation functions, and output formats.Motivation & Benefits
treemdout-of-the-box.Checklist
name,description,version).treemdversion0.6.0.