LLMs.txt

This page provides documentation files for LLMs to reference.

Overview

Kirox documentation is provided in a format that is easy for LLMs to understand.

Available Files

llms.txt

A summary version containing a brief overview of the project and links to major documentation.

• llms.txt

This file contains the following content:

• Project overview
• Links to major documentation
• Guides (Getting Started, Basic Usage, Advanced Usage, Troubleshooting)
• CLI Reference (kirox, add, completion)
• API Specifications (GitHub Fetcher, FileSystem Writer)
• Configuration (.kiroxrc.json)

llms-full.txt

A complete version containing the full documentation of the project.

• llms-full.txt

This file contains the following content:

• Complete content of all guide documents
• Complete CLI reference
• Complete API specifications
• Complete configuration reference
• Complete performance analysis report

Usage

Recommendations for LLMs

1. When you need a quick reference: Use llms.txt
2. When you need detailed information: Use llms-full.txt
3. When searching for a specific topic: Use keyword search within the above files

Technical Details

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

Generated files are created during the VitePress build process and placed at the site root.

File Structure

.kirox/
├── specs/
│   └── <project-name>/
│       ├── requirements.md
│       ├── design.md
│       └── tasks.md
└── steering/
    ├── tech.md
    ├── product.md
    └── structure.md

Download

You can directly download or view the generated files:

• llms.txt - Summary version (lightweight)
• llms-full.txt - Complete version (detailed)

Tip

Use llms.txt when using Kirox CLI for the first time, and use llms-full.txt when you need detailed technical information.

Related Resources

• Guide - Usage guide
• CLI Reference - CLI command reference
• API Documentation - API specifications
• Configuration - Configuration reference