llmsdottxt
An agent for getting information from llms.txt and llms-full.txt files
Installation
dagger install github.com/kpenfound/llmsdottxt@295761c4427c14a564636c1138856c9f09268818
Entrypoint
Return Type
Llmsdottxt !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
llmsFullTxt | File ! | - | The llms-full.txt file |
Example
dagger -m github.com/kpenfound/llmsdottxt@295761c4427c14a564636c1138856c9f09268818 call \
--llms-full-txt file:path
func (m *MyModule) Example(llmsFullTxt *dagger.File) *dagger.Llmsdottxt {
return dag.
Llmsdottxt(llmsFullTxt)
}
@function
def example(llms_full_txt: dagger.File) -> dagger.Llmsdottxt:
return (
dag.llmsdottxt(llms_full_txt)
)
@func()
example(llmsFullTxt: File): Llmsdottxt {
return dag
.llmsdottxt(llmsFullTxt)
}
Types
Llmsdottxt 🔗
grep() 🔗
grep for a pattern in the documentation returning the matches and surrounding context
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
pattern | String ! | - | pattern to grep for in the documentation |
Example
dagger -m github.com/kpenfound/llmsdottxt@295761c4427c14a564636c1138856c9f09268818 call \
--llms-full-txt file:path grep --pattern string
func (m *MyModule) Example(ctx context.Context, llmsFullTxt *dagger.File, pattern string) string {
return dag.
Llmsdottxt(llmsFullTxt).
Grep(ctx, pattern)
}
@function
async def example(llms_full_txt: dagger.File, pattern: str) -> str:
return await (
dag.llmsdottxt(llms_full_txt)
.grep(pattern)
)
@func()
async example(llmsFullTxt: File, pattern: string): Promise<string> {
return dag
.llmsdottxt(llmsFullTxt)
.grep(pattern)
}
section() 🔗
Read an entire section from the documentation
Return Type
String !
Arguments
Name | Type | Default Value | Description |
---|---|---|---|
heading | String ! | - | section from the table of contents to read. This can be a regex pattern |
Example
dagger -m github.com/kpenfound/llmsdottxt@295761c4427c14a564636c1138856c9f09268818 call \
--llms-full-txt file:path section --heading string
func (m *MyModule) Example(ctx context.Context, llmsFullTxt *dagger.File, heading string) string {
return dag.
Llmsdottxt(llmsFullTxt).
Section(ctx, heading)
}
@function
async def example(llms_full_txt: dagger.File, heading: str) -> str:
return await (
dag.llmsdottxt(llms_full_txt)
.section(heading)
)
@func()
async example(llmsFullTxt: File, heading: string): Promise<string> {
return dag
.llmsdottxt(llmsFullTxt)
.section(heading)
}
tableOfContents() 🔗
Generate a table of contents for the documentation
Return Type
String !
Example
dagger -m github.com/kpenfound/llmsdottxt@295761c4427c14a564636c1138856c9f09268818 call \
--llms-full-txt file:path table-of-contents
func (m *MyModule) Example(ctx context.Context, llmsFullTxt *dagger.File) string {
return dag.
Llmsdottxt(llmsFullTxt).
TableOfContents(ctx)
}
@function
async def example(llms_full_txt: dagger.File) -> str:
return await (
dag.llmsdottxt(llms_full_txt)
.table_of_contents()
)
@func()
async example(llmsFullTxt: File): Promise<string> {
return dag
.llmsdottxt(llmsFullTxt)
.tableOfContents()
}