catalogue — команда для Claude Code: что делает и как установить
Строит иерархическую структуру документации репозитория в JSON. Пригодится, когда нужен план wiki без генерации самих страниц.
.claude/commands/catalogue.mdЧто делает catalogue
catalogue анализирует текущий репозиторий и возвращает только JSON со структурой будущей wiki. Команда читает дерево файлов и README, определяет тип проекта, языки и фреймворки, затем раскладывает архитектуру, подсистемы, компоненты и ключевые методы по разделам. Для каждого промпта добавляются ссылки на реальные файлы.
Перед анализом команда проверяет git remote get-url origin, спрашивает, является ли репозиторий локальным, и определяет ветку через git rev-parse --abbrev-ref HEAD. Пока контекст исходного репозитория не разрешён, анализ не начинается. Для небольшого репозитория с ≤10 файлами создаётся только раздел Getting Started с 1–2 подразделами, без Deep Dive.
В Claude Code команда размещается в .claude/commands/catalogue.md; GitHub Copilot использует .github/prompts/catalogue.prompt.md. Максимальная глубина структуры — 4 уровня, а в каждом разделе допускается ≤8 дочерних элементов.
Какие задачи решает
- собрать план wiki для текущего репозитория
- разложить архитектуру по уровням документации
- связать разделы с файлами и строками кода
- отдельно описать Getting Started и Deep Dive
Примеры запросов агенту
- Запусти
/catalogueи создай JSON-структуру wiki для текущего репозитория. - Сначала определи источник репозитория и ветку, затем выполни
/catalogue. - Составь структуру документации с разделами архитектуры, подсистем и компонентов через
/catalogue.
Как установить catalogue
Вручную: положить файлы
.claude/commands/catalogue.mdВызов — /catalogue. Для всех проектов — ~/.claude/commands/
Вручную: положить файлы
~/.codex/prompts/catalogue.mdВызов — /prompts:catalogue. В Codex этот формат помечен устаревшим, замена — скиллы
Вручную: положить файлы
.github/prompts/catalogue.prompt.mdВручную: положить файлы
.gemini/commands/catalogue.tomlGemini хранит команды в TOML: текст запроса — в поле prompt
Вопросы о catalogue
Как установить catalogue в Claude Code?
Сохраните команду в файле .claude/commands/catalogue.md.
Что делает catalogue?
Команда анализирует репозиторий и генерирует только иерархическую JSON-структуру документации с промптами и ссылками на файлы.
Что нужно catalogue перед анализом репозитория?
Команда проверяет git remote get-url origin, спрашивает про локальный репозиторий или URL, а затем определяет ветку через git rev-parse --abbrev-ref HEAD. До разрешения этого контекста анализ не начинается.
Исходный текст
catalogue.md · MIT
---
description: Generate only the hierarchical wiki structure (table of contents) as JSON for the current repository
---
# Deep Wiki: Catalogue Generation
Analyze this repository and generate a hierarchical JSON documentation structure.
## Source Repository Resolution (MUST DO FIRST)
Before any analysis, 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 citations: `[file:line](REPO_URL/blob/BRANCH/file#Lline)`
- Local → use `(file_path:line_number)`
3. **Determine default branch**: Run `git rev-parse --abbrev-ref HEAD`
4. **Do NOT proceed** until resolved
## Analysis Phase
1. Read the repository file tree and README
2. Detect project type, language composition, frameworks
3. Identify architectural layers and module boundaries
4. Map key components, services, controllers, and their relationships
## Output Requirements
Generate a JSON structure following this schema:
```json
{
"items": [
{
"title": "getting-started",
"name": "[Derived from project]",
"prompt": "[Generation instruction]",
"children": [
{
"title": "[auto-derived]",
"name": "[Section Name]",
"prompt": "[1-3 sentence instruction with file citations]",
"children": []
}
]
},
{
"title": "deep-dive",
"name": "[Derived from project]",
"prompt": "[Generation instruction]",
"children": []
}
]
}
```
### Rules
- Max nesting depth: 4; ≤8 children per section
- Cite real files using the resolved citation format (linked or local) in every prompt
- Getting Started: overview, setup, basic usage, quick reference
- Deep Dive layers: Architecture → Subsystems → Components → Key methods/interfaces
- Component analysis: classes, services, controllers; dependencies; design patterns (Repository, Factory, Strategy, Observer)
- Small repo mode (≤10 files): Getting Started only, 1-2 children, skip Deep Dive
$ARGUMENTS
© microsoft · MIT · microsoft/skills
