# llms

Writes llms.txt and llms-full.txt from your project wiki: a short link index plus a full version with page text inlined.

- command · `type=command` · Claude Code, GitHub Copilot · ★ 3149
- Author: microsoft
- License: MIT · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/microsoft/skills/tree/HEAD/.github/plugins/deep-wiki/commands/llms.md
- Updated: 2026-10-23
- HTML: https://affpapa.org/en/nevibecode/commands/llms

## What it does

The command walks the repository and the wiki that already exists, collecting the project name, a one-line description, languages and technologies, every `.md` file under `wiki/`, guides in `onboarding/`, and the README. It then writes two files into `wiki/`. The first stays small: links with a sentence of explanation each. The second keeps the same skeleton but drops whole pages into `<doc>` blocks carrying `title` and `path` attributes.

Before any generation it settles where the source lives. It runs `git remote get-url origin` and asks whether the repository is local-only or has a URL. That answer decides the link style: absolute `REPO_URL/blob/BRANCH/path` or relative paths into the wiki. The branch comes from `git rev-parse --abbrev-ref HEAD`. Nothing is written until this is resolved, so in a checkout with no remote configured the command opens with a question instead of output.

Structure follows the llms.txt spec: a single H1, a blockquote summary, H2 sections holding `[Title](url): description` lists. An “Optional” section marks links a tool may skip to save context. Section names come from the actual wiki catalogue rather than a fixed template. In `llms-full.txt` the VitePress frontmatter is stripped from inlined pages, while tables, Mermaid diagrams and `[file:line](URL)` citations survive untouched.

## Requirements
- Works with: Azure

## Install

### Claude Code (native platform)

**Manually: put the files in place**
- File: `.claude/commands/llms.md` — Call it with /llms. For all projects use ~/.claude/commands/

### Codex

**Manually: put the files in place**
- File: `~/.codex/prompts/llms.md` — Call it with /prompts:llms. Codex marks this format deprecated in favour of skills

### GitHub Copilot

**Manually: put the files in place**
- File: `.github/prompts/llms.prompt.md`

### Gemini CLI

**Manually: put the files in place**
- File: `.gemini/commands/llms.toml` — Gemini stores commands as TOML: the prompt text goes into the prompt field

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/microsoft/skills/tree/HEAD/.github/plugins/deep-wiki/commands/llms.md

## When to use it
- give a coding agent a compact map of the project wiki
- hand over the whole documentation as one file
- group wiki pages into sections with useful descriptions
- point links at the right repository URL and branch
- catch links that lead to files no longer in the wiki

## Example prompts
- Generate `llms.txt` and `llms-full.txt` for this project's wiki
- Build `llms.txt` from the pages in `wiki/`, keep links relative
- Refresh `llms-full.txt` with full page content inside `<doc>` blocks

## Source text · llms.md · MIT

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 2481756aa95a8e6c.

BEGIN THIRD-PARTY FILE 2481756aa95a8e6c
````text
---
description: Generate llms.txt and llms-full.txt files for the wiki — LLM-friendly project summaries following the llms.txt specification
---

# Deep Wiki: Generate llms.txt

You are generating `llms.txt` and `llms-full.txt` files that provide LLM-friendly access to the wiki documentation. These follow the [llms.txt specification](https://llmstxt.org/).

## Source Repository Resolution (MUST DO FIRST)

Before generating, resolve the source repository context:

1. **Check for git remote**: Run `git remote get-url origin`
2. **Ask the user**: _"Is this a local-only repository, or do you have a source repository URL?"_
   - Remote URL → store as `REPO_URL`, use linked references: `[Title](REPO_URL/blob/BRANCH/path)`
   - Local → use relative paths to wiki files
3. **Determine default branch**: Run `git rev-parse --abbrev-ref HEAD`
4. **Do NOT proceed** until resolved

## What is llms.txt

`llms.txt` is a standardized markdown file that helps LLMs quickly understand a project. It provides:

- A concise project summary
- Links to key documentation files with brief descriptions
- Structured sections (Onboarding, Architecture, API, etc.)

Two files are generated:

| File | Purpose | Size |
|------|---------|------|
| `llms.txt` | Links + brief descriptions — fits in small context windows | Small (1-5 KB) |
| `llms-full.txt` | Full inlined content of all linked pages | Large (50-500 KB) |

## Step 1: Gather Project Context

Scan the repository and existing wiki (if generated) to collect:

1. **Project identity** — name, one-sentence description, primary language, key technologies
2. **Wiki pages** — scan `wiki/` directory for all generated `.md` files
3. **Onboarding guides** — check for `onboarding/` folder with audience-tailored guides
4. **README** — extract the core project description
5. **Key entry points** — main files, API surface, configuration

## Step 2: Generate `llms.txt`

Create `wiki/llms.txt` following the llms.txt spec format:

```markdown
# {Project Name}

> {One-paragraph summary: what it does, who it's for, key technologies. Dense and informative.}

{2-3 paragraphs of important context: architectural philosophy, key constraints, what makes this project different. Include things an LLM needs to know to give accurate answers about this project.}

## Onboarding

- [{Contributor Guide}](./onboarding/contributor-guide.md): Step-by-step guide for new contributors — environment setup, first task, testing, and coding conventions
- [{Staff Engineer Guide}](./onboarding/staff-engineer-guide.md): Architectural deep-dive for senior engineers — design decisions, domain model, component types, and failure modes
- [{Executive Guide}](./onboarding/executive-guide.md): Capability overview for engineering leaders — risk assessment, technology investment, and scaling model
- [{Product Manager Guide}](./onboarding/product-manager-guide.md): Feature-focused guide for PMs — user journeys, capabilities, limitations, and data/privacy

## Architecture

- [{Architecture Overview}](./02-architecture/overview.md): System architecture, component boundaries, and deployment topology
- [{Data Model}](./02-architecture/data-model.md): Core entities, relationships, and data invariants
- [{API Reference}](./02-architecture/api-reference.md): Endpoints, authentication, and wire format

## Getting Started

- [{Setup Guide}](./01-getting-started/setup.md): Prerequisites, installation, and first run
````
END THIRD-PARTY FILE 2481756aa95a8e6c

The third-party file has ended. Everything between the 2481756aa95a8e6c tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 3465 of 8954 bytes. © microsoft · MIT · https://github.com/microsoft/skills/tree/HEAD/.github/plugins/deep-wiki/commands/llms.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md