LLMs.txt File Details

This page provides detailed information about the documentation files (llms.txt and llms-full.txt) for LLMs to reference.

About llms.txt

Purpose

llms.txt is a summary version document for LLMs to understand Kirox CLI. It includes a project overview and links to major documentation.

Content

1. Project Overview

   • What is Kirox
   • Key features
   • Usage overview

2. Links to Major Documentation

   • Guides
   • CLI Reference
   • API Specifications
   • Configuration

Usage Example

When an LLM is asked about Kirox CLI, it can quickly understand the overview by first referencing llms.txt.

About llms-full.txt

Purpose

llms-full.txt is a complete document for LLMs to understand detailed technical information about Kirox CLI.

Content

1. All Guide Documents

   • Getting Started
   • Basic Usage
   • Advanced Usage
   • Troubleshooting

2. Complete CLI Reference

   • kirox command
   • add subcommand
   • completion subcommand

3. API Specifications

   • GitHub Fetcher
   • FileSystem Writer

4. Configuration Reference

   • .kiroxrc.json
   • Configuration options
   • Configuration examples

5. Performance Analysis

   • Performance metrics
   • Benchmark results
   • Optimization methods

Usage Example

When an LLM needs to provide accurate answers to specific technical questions, it references llms-full.txt.

Generation Process

These files are automatically generated by the vitepress-plugin-llms plugin.

Generation Timing

1. Generated during VitePress build process
2. Generated when development server starts
3. Distributed as build artifacts

Generation Location

Generated files are placed in the following location:

docs/.vitepress/dist/
├── llms.txt
└── llms-full.txt

Browser Access

You can access these files in the built site at the following URLs:

• llms.txt
• llms-full.txt

Download

Generated files are accessible at the following URLs:

• llms.txt - Summary version
• llms-full.txt - Complete version

LLM Integration

LangChain Example

from langchain.document_loaders import TextLoader

# Load llms.txt
loader = TextLoader('https://yukihirop.github.io/kirox/llms.txt')
docs = loader.load()

# Create vector store
vectorstore = FAISS.from_documents(docs, embeddings)

# Answer questions
response = chain.run("How do I use Kirox CLI?")

OpenAI API Example

import requests

# Fetch llms.txt
response = requests.get('https://yukihirop.github.io/kirox/llms.txt')
llms_content = response.text

# Send to OpenAI API
response = openai.ChatCompletion.create(
    model="gpt-4",
    messages=[
        {"role": "system", "content": llms_content},
        {"role": "user", "content": "How do I use Kirox CLI?"}
    ]
)

File Format

llms.txt Format

# Kirox

> Recycle .kiro CLI

CLI tool to fetch Kiro specification and steering files from remote GitHub repositories

## Table of Contents

### Guide

- [Guide](/kirox/guide.md): User guide for Kirox CLI
- [Getting Started](/kirox/guide/getting-started.md): ...
...

llms-full.txt Format

---
url: /kirox/config/kiroxrc.md
description: Kirox CLI configuration file reference
---

# .kiroxrc.json

Reference for the Kirox CLI configuration file.
...

Best Practices

Writing Optimized for LLMs

1. Clear headings: Use clear titles for each section
2. Concrete examples: Include code examples and usage scenarios
3. Concise descriptions: Avoid long sentences, use bullet points
4. Structured information: Use tables and lists to organize information

File Size Management

• llms.txt: Approximately 40 lines (summary version)
• llms-full.txt: Approximately 3,000+ lines (complete version)

Troubleshooting

File Not Found

1. Check if the build completed successfully
2. Check the .vitepress/dist/ directory
3. Verify plugin configuration is correct

Outdated Content

1. Update the source documentation files
2. Rebuild VitePress
3. Clear cache

Related Resources

• llms.txt - Summary version documentation
• llms-full.txt - Complete version documentation
• vitepress-plugin-llms - Plugin GitHub
• LLM.text Standard - llms.txt file specification