@yeongjaeyou/claude-code-config 0.5.0 → 0.5.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/commands/generate-llmstxt.md +49 -0
- package/.claude/skills/feature-implementer/SKILL.md +317 -0
- package/.claude/skills/feature-implementer/plan-template.md +605 -0
- package/README.md +169 -129
- package/package.json +1 -1
- package/.claude/agents/generate-llmstxt.md +0 -165
- package/.claude/agents/langconnect-rag-expert.md +0 -98
- package/.claude/commands/plan.md +0 -26
- package/.claude/commands/tm/review-prd-with-codex.md +0 -442
package/README.md
CHANGED
|
@@ -1,146 +1,176 @@
|
|
|
1
1
|
# Claude Code Config
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A collection of custom slash commands, agents, and skills for Claude Code CLI.
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Structure
|
|
6
6
|
|
|
7
7
|
```
|
|
8
8
|
.claude/
|
|
9
|
-
├── commands/ #
|
|
10
|
-
│ ├── ask-codex.md #
|
|
11
|
-
│ ├── ask-deepwiki.md #
|
|
12
|
-
│ ├── ask-gemini.md #
|
|
13
|
-
│ ├── code-review.md #
|
|
14
|
-
│ ├── commit-and-push.md # Git
|
|
15
|
-
│ ├──
|
|
16
|
-
│ ├──
|
|
9
|
+
├── commands/ # Slash commands
|
|
10
|
+
│ ├── ask-codex.md # Request code review via Codex MCP
|
|
11
|
+
│ ├── ask-deepwiki.md # Deep query GitHub repos via DeepWiki
|
|
12
|
+
│ ├── ask-gemini.md # Request code review via Gemini CLI
|
|
13
|
+
│ ├── code-review.md # Process external code reviews (CodeRabbit, etc.)
|
|
14
|
+
│ ├── commit-and-push.md # Automate Git commit and push
|
|
15
|
+
│ ├── council.md # Consult multiple AI models (LLM Council)
|
|
16
|
+
│ ├── edit-notebook.md # Safely edit Jupyter Notebooks
|
|
17
|
+
│ ├── generate-llmstxt.md # Generate llms.txt from URL or directory
|
|
17
18
|
│ ├── gh/
|
|
18
|
-
│ │ ├── create-issue-label.md # GitHub
|
|
19
|
-
│ │ ├── decompose-issue.md #
|
|
20
|
-
│ │ ├── init-project.md # GitHub Project
|
|
21
|
-
│ │ ├── post-merge.md #
|
|
22
|
-
│ │ └── resolve-issue.md # GitHub
|
|
19
|
+
│ │ ├── create-issue-label.md # Create GitHub issue labels
|
|
20
|
+
│ │ ├── decompose-issue.md # Decompose large work into issues
|
|
21
|
+
│ │ ├── init-project.md # Initialize GitHub Project board
|
|
22
|
+
│ │ ├── post-merge.md # Post-merge cleanup
|
|
23
|
+
│ │ └── resolve-issue.md # GitHub issue resolution workflow
|
|
23
24
|
│ └── tm/
|
|
24
|
-
│ ├── convert-prd.md # PRD
|
|
25
|
-
│ ├── post-merge.md # TaskMaster
|
|
26
|
-
│ ├── resolve-issue.md # TaskMaster
|
|
27
|
-
│
|
|
28
|
-
|
|
29
|
-
├──
|
|
30
|
-
│
|
|
31
|
-
|
|
32
|
-
│ ├──
|
|
33
|
-
│ └──
|
|
34
|
-
└── skills/ #
|
|
35
|
-
|
|
25
|
+
│ ├── convert-prd.md # Convert PRD draft to TaskMaster format
|
|
26
|
+
│ ├── post-merge.md # TaskMaster-integrated post-merge cleanup
|
|
27
|
+
│ ├── resolve-issue.md # TaskMaster-based issue resolution
|
|
28
|
+
│ └── sync-to-github.md # Sync TaskMaster -> GitHub
|
|
29
|
+
├── guidelines/ # Shared guidelines
|
|
30
|
+
│ ├── work-guidelines.md # Common work guidelines
|
|
31
|
+
│ └── id-reference.md # GitHub/TaskMaster ID reference
|
|
32
|
+
├── agents/ # Custom agents
|
|
33
|
+
│ ├── web-researcher.md # Multi-platform web research
|
|
34
|
+
│ └── python-pro.md # Python expert
|
|
35
|
+
└── skills/ # Skills (reusable tool collections)
|
|
36
|
+
├── code-explorer/ # GitHub/HuggingFace code exploration
|
|
37
|
+
│ ├── SKILL.md
|
|
38
|
+
│ ├── scripts/
|
|
39
|
+
│ └── references/
|
|
40
|
+
├── feature-implementer/ # TDD-based feature planning
|
|
41
|
+
│ ├── SKILL.md
|
|
42
|
+
│ └── plan-template.md
|
|
43
|
+
├── notion-md-uploader/ # Upload Markdown to Notion
|
|
44
|
+
│ ├── SKILL.md
|
|
45
|
+
│ ├── scripts/
|
|
46
|
+
│ └── references/
|
|
47
|
+
└── skill-creator/ # Guide for creating skills
|
|
36
48
|
├── SKILL.md
|
|
37
|
-
|
|
38
|
-
│ ├── search_github.py
|
|
39
|
-
│ └── search_huggingface.py
|
|
40
|
-
└── references/
|
|
41
|
-
├── github_api.md
|
|
42
|
-
└── huggingface_api.md
|
|
49
|
+
└── scripts/
|
|
43
50
|
```
|
|
44
51
|
|
|
45
|
-
##
|
|
52
|
+
## Slash Commands
|
|
46
53
|
|
|
47
|
-
###
|
|
54
|
+
### General Commands
|
|
48
55
|
|
|
49
|
-
|
|
|
50
|
-
|
|
51
|
-
| `/
|
|
52
|
-
| `/
|
|
53
|
-
| `/
|
|
54
|
-
| `/
|
|
55
|
-
| `/ask-deepwiki` |
|
|
56
|
-
| `/ask-codex` |
|
|
57
|
-
| `/ask-gemini` |
|
|
56
|
+
| Command | Description |
|
|
57
|
+
|---------|-------------|
|
|
58
|
+
| `/commit-and-push` | Analyze changes and commit with Conventional Commits format |
|
|
59
|
+
| `/code-review` | Process external code review results and apply auto-fixes |
|
|
60
|
+
| `/edit-notebook` | Safely edit Jupyter Notebook files with NotebookEdit tool |
|
|
61
|
+
| `/generate-llmstxt` | Generate llms.txt from URL or local directory |
|
|
62
|
+
| `/ask-deepwiki` | Deep query GitHub repositories via DeepWiki MCP |
|
|
63
|
+
| `/ask-codex` | Request code review via Codex MCP (with Claude cross-check) |
|
|
64
|
+
| `/ask-gemini` | Request code review via Gemini CLI (with Claude cross-check) |
|
|
65
|
+
| `/council` | Consult multiple AI models and synthesize collective wisdom |
|
|
58
66
|
|
|
59
|
-
### GitHub
|
|
67
|
+
### GitHub Workflow Commands (`/gh/`)
|
|
60
68
|
|
|
61
|
-
|
|
|
62
|
-
|
|
63
|
-
| `/gh/create-issue-label` |
|
|
64
|
-
| `/gh/decompose-issue` |
|
|
65
|
-
| `/gh/init-project` |
|
|
66
|
-
| `/gh/post-merge` |
|
|
67
|
-
| `/gh/resolve-issue` |
|
|
69
|
+
| Command | Description |
|
|
70
|
+
|---------|-------------|
|
|
71
|
+
| `/gh/create-issue-label` | Analyze project and create appropriate GitHub issue labels |
|
|
72
|
+
| `/gh/decompose-issue` | Decompose large work into manageable independent issues |
|
|
73
|
+
| `/gh/init-project` | Initialize and configure GitHub Project board |
|
|
74
|
+
| `/gh/post-merge` | Clean up branch and update CLAUDE.md after PR merge |
|
|
75
|
+
| `/gh/resolve-issue` | Systematically analyze and resolve GitHub issues |
|
|
68
76
|
|
|
69
|
-
### TaskMaster
|
|
77
|
+
### TaskMaster Integration Commands (`/tm/`)
|
|
70
78
|
|
|
71
|
-
|
|
|
72
|
-
|
|
73
|
-
| `/tm/convert-prd` | PRD
|
|
74
|
-
| `/tm/sync-to-github` | TaskMaster tasks.json
|
|
75
|
-
| `/tm/resolve-issue` | GitHub
|
|
76
|
-
| `/tm/
|
|
77
|
-
| `/tm/post-merge` | PR 머지 후 TaskMaster 상태 업데이트 및 브랜치 정리 |
|
|
79
|
+
| Command | Description |
|
|
80
|
+
|---------|-------------|
|
|
81
|
+
| `/tm/convert-prd` | Convert PRD draft to TaskMaster PRD format |
|
|
82
|
+
| `/tm/sync-to-github` | Sync TaskMaster tasks.json to GitHub Issues/Milestones |
|
|
83
|
+
| `/tm/resolve-issue` | Resolve GitHub Issues by TaskMaster subtask units |
|
|
84
|
+
| `/tm/post-merge` | TaskMaster status update and branch cleanup after PR merge |
|
|
78
85
|
|
|
79
|
-
##
|
|
86
|
+
## Agents
|
|
80
87
|
|
|
81
|
-
|
|
|
82
|
-
|
|
83
|
-
| `web-researcher` |
|
|
84
|
-
| `python-pro` | Python
|
|
85
|
-
| `generate-llmstxt` | 웹사이트나 로컬 디렉토리에서 llms.txt 문서 생성 |
|
|
86
|
-
| `langconnect-rag-expert` | RAG 기반 문서 컬렉션에서 정보 검색 및 종합 |
|
|
88
|
+
| Agent | Description |
|
|
89
|
+
|-------|-------------|
|
|
90
|
+
| `web-researcher` | Multi-platform tech research (Reddit, GitHub, SO, HF, arXiv, etc.) |
|
|
91
|
+
| `python-pro` | Python advanced features expert (decorators, generators, async/await) |
|
|
87
92
|
|
|
88
|
-
##
|
|
93
|
+
## Skills
|
|
89
94
|
|
|
90
95
|
### code-explorer
|
|
91
96
|
|
|
92
|
-
|
|
97
|
+
Search and analyze code/models/datasets on GitHub and Hugging Face.
|
|
93
98
|
|
|
94
99
|
```bash
|
|
95
|
-
# GitHub
|
|
100
|
+
# Search GitHub repositories
|
|
96
101
|
python scripts/search_github.py "object detection" --limit 10
|
|
97
102
|
|
|
98
|
-
# Hugging Face
|
|
103
|
+
# Search Hugging Face models/datasets/Spaces
|
|
99
104
|
python scripts/search_huggingface.py "qwen vl" --type models
|
|
100
105
|
```
|
|
101
106
|
|
|
102
|
-
|
|
107
|
+
### feature-implementer
|
|
103
108
|
|
|
104
|
-
|
|
109
|
+
TDD-based feature planning with quality gates.
|
|
110
|
+
|
|
111
|
+
- Phase-based plans with 1-4 hour increments
|
|
112
|
+
- Test-First Development (Red-Green-Refactor)
|
|
113
|
+
- Quality gates before each phase transition
|
|
114
|
+
- Risk assessment and rollback strategies
|
|
115
|
+
|
|
116
|
+
### notion-md-uploader
|
|
117
|
+
|
|
118
|
+
Upload Markdown files to Notion pages with full formatting support.
|
|
119
|
+
|
|
120
|
+
- Headings, lists, code blocks, images, tables, callouts, todos
|
|
121
|
+
- Automatic image uploads
|
|
122
|
+
- Preserved formatting
|
|
123
|
+
|
|
124
|
+
### skill-creator
|
|
125
|
+
|
|
126
|
+
Guide for creating effective Claude Code skills.
|
|
127
|
+
|
|
128
|
+
- Skill structure templates
|
|
129
|
+
- Best practices
|
|
130
|
+
- Validation scripts
|
|
131
|
+
|
|
132
|
+
## Installation
|
|
133
|
+
|
|
134
|
+
### Install with npx (Recommended)
|
|
105
135
|
|
|
106
136
|
```bash
|
|
107
|
-
#
|
|
137
|
+
# Install to current project
|
|
108
138
|
npx @yeongjaeyou/claude-code-config
|
|
109
139
|
|
|
110
|
-
#
|
|
140
|
+
# Global install (available in all projects)
|
|
111
141
|
npx @yeongjaeyou/claude-code-config --global
|
|
112
142
|
```
|
|
113
143
|
|
|
114
|
-
###
|
|
144
|
+
### Manual Installation
|
|
115
145
|
|
|
116
146
|
```bash
|
|
117
|
-
#
|
|
147
|
+
# Method 1: Direct copy
|
|
118
148
|
git clone https://github.com/YoungjaeDev/claude-code-config.git
|
|
119
149
|
cp -r claude-code-config/.claude /path/to/your/project/
|
|
120
150
|
|
|
121
|
-
#
|
|
151
|
+
# Method 2: Symbolic link
|
|
122
152
|
ln -s /path/to/claude-code-config/.claude /path/to/your/project/.claude
|
|
123
153
|
```
|
|
124
154
|
|
|
125
|
-
### CLI
|
|
155
|
+
### CLI Options
|
|
126
156
|
|
|
127
157
|
```bash
|
|
128
|
-
npx @yeongjaeyou/claude-code-config [
|
|
158
|
+
npx @yeongjaeyou/claude-code-config [options]
|
|
129
159
|
|
|
130
|
-
|
|
131
|
-
-g, --global
|
|
132
|
-
-h, --help
|
|
133
|
-
-v, --version
|
|
160
|
+
Options:
|
|
161
|
+
-g, --global Global install (~/.claude/)
|
|
162
|
+
-h, --help Show help
|
|
163
|
+
-v, --version Show version
|
|
134
164
|
```
|
|
135
165
|
|
|
136
|
-
## MCP
|
|
166
|
+
## MCP Server Configuration
|
|
137
167
|
|
|
138
|
-
|
|
168
|
+
The package includes `.mcp.json` that can be copied to your project root.
|
|
139
169
|
|
|
140
|
-
###
|
|
170
|
+
### Prerequisites
|
|
141
171
|
|
|
142
|
-
- **Node.js**: npx
|
|
143
|
-
- **Python uv**: [uv
|
|
172
|
+
- **Node.js**: For npx command
|
|
173
|
+
- **Python uv**: [Install uv](https://docs.astral.sh/uv/getting-started/installation/)
|
|
144
174
|
```bash
|
|
145
175
|
# macOS/Linux
|
|
146
176
|
curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
@@ -149,68 +179,78 @@ npx @yeongjaeyou/claude-code-config [옵션]
|
|
|
149
179
|
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
|
|
150
180
|
```
|
|
151
181
|
|
|
152
|
-
###
|
|
182
|
+
### Included MCP Servers
|
|
153
183
|
|
|
154
|
-
|
|
|
155
|
-
|
|
156
|
-
| mcpdocs | Claude Code, Cursor
|
|
157
|
-
| deepwiki | GitHub
|
|
158
|
-
| serena | LSP
|
|
184
|
+
| Server | Description | API Key |
|
|
185
|
+
|--------|-------------|---------|
|
|
186
|
+
| mcpdocs | Claude Code, Cursor docs search (mcp-cache wrapper) | Not required |
|
|
187
|
+
| deepwiki | GitHub repository documentation query | Not required |
|
|
188
|
+
| serena | LSP-based code analysis tool | Not required |
|
|
159
189
|
|
|
160
|
-
###
|
|
190
|
+
### Usage
|
|
161
191
|
|
|
162
192
|
```bash
|
|
163
|
-
# .mcp.json
|
|
193
|
+
# Copy .mcp.json
|
|
164
194
|
cp node_modules/@yeongjaeyou/claude-code-config/.mcp.json .
|
|
165
195
|
|
|
166
|
-
#
|
|
196
|
+
# Or merge contents if you have existing .mcp.json
|
|
167
197
|
```
|
|
168
198
|
|
|
169
|
-
>
|
|
170
|
-
|
|
171
|
-
## 사용법
|
|
199
|
+
> **Note**: If you have your own `.mcp.json`, manually merge the `mcpServers` object.
|
|
172
200
|
|
|
173
|
-
|
|
201
|
+
## Usage Examples
|
|
174
202
|
|
|
175
203
|
```bash
|
|
176
|
-
#
|
|
177
|
-
/
|
|
204
|
+
# Generate llms.txt from website
|
|
205
|
+
/generate-llmstxt https://docs.example.com
|
|
178
206
|
|
|
179
|
-
#
|
|
207
|
+
# Commit and push
|
|
180
208
|
/commit-and-push src/auth.ts src/utils.ts
|
|
181
209
|
|
|
182
|
-
# GitHub
|
|
210
|
+
# Resolve GitHub issue
|
|
183
211
|
/gh/resolve-issue 42
|
|
212
|
+
|
|
213
|
+
# Consult AI council
|
|
214
|
+
/council "Should we use REST or GraphQL for this API?"
|
|
184
215
|
```
|
|
185
216
|
|
|
186
|
-
##
|
|
217
|
+
## Key Features
|
|
218
|
+
|
|
219
|
+
### `/generate-llmstxt` - LLM Documentation
|
|
220
|
+
- Generate llms.txt from URL or local directory
|
|
221
|
+
- Use Firecrawl MCP for web scraping
|
|
222
|
+
- Organize content into logical sections
|
|
223
|
+
|
|
224
|
+
### `/commit-and-push` - Git Automation
|
|
225
|
+
- Follow Conventional Commits format (feat, fix, refactor, docs, etc.)
|
|
226
|
+
- Analyze changes and generate appropriate commit message
|
|
227
|
+
- Selectively commit specified files only
|
|
187
228
|
|
|
188
|
-
### `/
|
|
189
|
-
-
|
|
190
|
-
-
|
|
191
|
-
-
|
|
192
|
-
- **바로 코드를 작성하지 않고 계획만 수립**
|
|
229
|
+
### `/edit-notebook` - Jupyter Notebook Editing
|
|
230
|
+
- Use only `NotebookEdit` tool (protect JSON structure)
|
|
231
|
+
- Track cell_id for correct insertion order
|
|
232
|
+
- Include source format issue resolution guide
|
|
193
233
|
|
|
194
|
-
### `/
|
|
195
|
-
-
|
|
196
|
-
-
|
|
197
|
-
-
|
|
234
|
+
### `/council` - LLM Council
|
|
235
|
+
- Query multiple AI models (Opus, Sonnet, Codex, Gemini) in parallel
|
|
236
|
+
- Anonymize responses for unbiased evaluation
|
|
237
|
+
- Synthesize collective wisdom into consensus
|
|
198
238
|
|
|
199
|
-
###
|
|
200
|
-
- `
|
|
201
|
-
-
|
|
202
|
-
-
|
|
239
|
+
### `web-researcher` Agent
|
|
240
|
+
- Multi-platform search: GitHub (`gh` CLI), Hugging Face, Reddit, SO, arXiv
|
|
241
|
+
- Official documentation via Context7/DeepWiki
|
|
242
|
+
- Auto-generate research reports
|
|
203
243
|
|
|
204
|
-
### `
|
|
205
|
-
-
|
|
206
|
-
-
|
|
207
|
-
-
|
|
244
|
+
### `feature-implementer` Skill
|
|
245
|
+
- TDD-based feature planning with quality gates
|
|
246
|
+
- Phase-based delivery (1-4 hours per phase)
|
|
247
|
+
- Risk assessment and rollback strategies
|
|
208
248
|
|
|
209
|
-
### `code-explorer`
|
|
210
|
-
- `gh` CLI
|
|
211
|
-
- `huggingface_hub` API
|
|
212
|
-
-
|
|
249
|
+
### `code-explorer` Skill
|
|
250
|
+
- GitHub repository/code search via `gh` CLI
|
|
251
|
+
- Hugging Face model/dataset/Spaces search via `huggingface_hub` API
|
|
252
|
+
- Download and analyze source code in temp directory (`/tmp/`)
|
|
213
253
|
|
|
214
|
-
##
|
|
254
|
+
## License
|
|
215
255
|
|
|
216
256
|
MIT License
|
package/package.json
CHANGED
|
@@ -1,165 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: generate-llmstxt
|
|
3
|
-
description: Expert at generating llms.txt files from websites or local directories. Use when user requests to create llms.txt documentation from URLs or local folders.
|
|
4
|
-
tools: Task, mcp__firecrawl__firecrawl_map, mcp__firecrawl__firecrawl_scrape, Bash, Read, Write, Glob, Grep
|
|
5
|
-
model: sonnet
|
|
6
|
-
color: orange
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
You are an expert at creating llms.txt documentation files following the llms.txt standard specification.
|
|
10
|
-
|
|
11
|
-
# Your Primary Responsibilities
|
|
12
|
-
|
|
13
|
-
1. Generate well-structured llms.txt files from websites or local directories
|
|
14
|
-
2. Follow the llms.txt format specification precisely
|
|
15
|
-
3. Use parallel processing for efficient content gathering
|
|
16
|
-
4. Summarize content concisely while preserving key information
|
|
17
|
-
|
|
18
|
-
# llms.txt Format Specification
|
|
19
|
-
|
|
20
|
-
The llms.txt file should contain:
|
|
21
|
-
1. An H1 with the project/site name (required)
|
|
22
|
-
2. An optional blockquote with a short project summary
|
|
23
|
-
3. Optional detailed markdown sections
|
|
24
|
-
4. Optional markdown sections with H2 headers listing URLs
|
|
25
|
-
|
|
26
|
-
Example Format:
|
|
27
|
-
```markdown
|
|
28
|
-
# Title
|
|
29
|
-
|
|
30
|
-
> Optional description goes here
|
|
31
|
-
|
|
32
|
-
Optional details go here
|
|
33
|
-
|
|
34
|
-
## Section name
|
|
35
|
-
|
|
36
|
-
- [Link title](https://link_url): Optional link details
|
|
37
|
-
|
|
38
|
-
## Optional
|
|
39
|
-
|
|
40
|
-
- [Link title](https://link_url)
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
Key Guidelines:
|
|
44
|
-
- Use concise, clear language
|
|
45
|
-
- Provide brief, informative descriptions for linked resources (10-15 words max)
|
|
46
|
-
- Avoid ambiguous terms or unexplained jargon
|
|
47
|
-
- Group related links under appropriate section headings
|
|
48
|
-
- Each description should be SPECIFIC to the content, not generic
|
|
49
|
-
|
|
50
|
-
## URL Format Best Practices
|
|
51
|
-
|
|
52
|
-
When documenting projects with official documentation:
|
|
53
|
-
1. **Always prefer official web documentation URLs** over GitHub/repository URLs
|
|
54
|
-
- ✅ Good: `https://docs.example.com/guide.html`
|
|
55
|
-
- ❌ Avoid: `https://github.com/example/repo/blob/main/docs/guide.md`
|
|
56
|
-
2. **Check for published documentation sites** even if source is on GitHub
|
|
57
|
-
- Many projects publish to readthedocs.io, GitHub Pages, or custom domains
|
|
58
|
-
- Example: TorchServe uses `https://pytorch.org/serve/` not GitHub URLs
|
|
59
|
-
3. **Use HTML versions** when both .md and .html exist
|
|
60
|
-
- Published docs usually have .html extension
|
|
61
|
-
- Some sites append .html.md for markdown versions
|
|
62
|
-
4. **Verify URL accessibility** before including in llms.txt
|
|
63
|
-
|
|
64
|
-
# Workflow for URL Input
|
|
65
|
-
|
|
66
|
-
When given a URL to generate llms.txt from:
|
|
67
|
-
|
|
68
|
-
1. Use firecrawl_map to discover all URLs on the website
|
|
69
|
-
2. Create multiple parallel Task agents to scrape each URL concurrently
|
|
70
|
-
- Each task should use firecrawl_scrape to fetch page content
|
|
71
|
-
- Each task should extract key information: page title, main concepts, important links
|
|
72
|
-
3. Collect and synthesize all results
|
|
73
|
-
4. Organize content into logical sections
|
|
74
|
-
5. Generate the final llms.txt file following the specification
|
|
75
|
-
|
|
76
|
-
Important: DO NOT use firecrawl_generate_llmstxt - build the llms.txt manually from scraped content.
|
|
77
|
-
|
|
78
|
-
# Workflow for Local Directory Input
|
|
79
|
-
|
|
80
|
-
When given a local directory path:
|
|
81
|
-
|
|
82
|
-
1. **Comprehensive Discovery**: Use Bash (ls/find) or Glob to list ALL files
|
|
83
|
-
- Check main directory (e.g., `docs/`)
|
|
84
|
-
- IMPORTANT: Also check subdirectories (e.g., `docs/hardware_support/`)
|
|
85
|
-
- Use recursive listing to avoid missing files
|
|
86
|
-
- Example: `ls -1 /path/to/docs/*.md` AND `ls -1 /path/to/docs/*/*.md`
|
|
87
|
-
|
|
88
|
-
2. **Verify Completeness**: Count total files and cross-reference
|
|
89
|
-
- Use `wc -l` to count total markdown files
|
|
90
|
-
- Compare against what's included in llms.txt
|
|
91
|
-
- Example: If docs/ has 36 files, ensure all 36 are considered
|
|
92
|
-
|
|
93
|
-
3. Filter for documentation-relevant files (README, docs, markdown files, code files)
|
|
94
|
-
|
|
95
|
-
4. Create parallel Task agents to read and analyze relevant files
|
|
96
|
-
- Each task should use Read to get file contents
|
|
97
|
-
- Each task should extract: file purpose, key functions/classes, important concepts
|
|
98
|
-
|
|
99
|
-
5. Collect and synthesize all results
|
|
100
|
-
|
|
101
|
-
6. Organize content into logical sections (e.g., "Core Modules", "Documentation", "Examples")
|
|
102
|
-
|
|
103
|
-
7. Generate the final llms.txt file following the specification
|
|
104
|
-
|
|
105
|
-
# Content Summarization Strategy
|
|
106
|
-
|
|
107
|
-
For each page or file, extract:
|
|
108
|
-
- Main purpose or topic
|
|
109
|
-
- Key APIs, functions, or classes (for code)
|
|
110
|
-
- Important concepts or features
|
|
111
|
-
- Usage examples or patterns
|
|
112
|
-
- Related resources
|
|
113
|
-
|
|
114
|
-
**CRITICAL: Read actual content, don't assume!**
|
|
115
|
-
- ✅ Good: "Configure batch size and delay for optimized throughput with dynamic batching"
|
|
116
|
-
- ❌ Bad: "Information about batch inference configuration"
|
|
117
|
-
- Each description MUST be based on actually reading the page/file content
|
|
118
|
-
- Descriptions should be 10-15 words and SPECIFIC to that document
|
|
119
|
-
- Avoid generic phrases like "documentation about X" or "guide for Y"
|
|
120
|
-
- Include concrete details: specific features, APIs, tools, or concepts mentioned
|
|
121
|
-
|
|
122
|
-
Keep descriptions brief (1-2 sentences per item) but informative and specific.
|
|
123
|
-
|
|
124
|
-
# Section Organization
|
|
125
|
-
|
|
126
|
-
Organize content into logical sections such as:
|
|
127
|
-
- Documentation (for docs, guides, tutorials)
|
|
128
|
-
- API Reference (for API documentation)
|
|
129
|
-
- Examples (for code examples, tutorials)
|
|
130
|
-
- Resources (for additional materials)
|
|
131
|
-
- Tools (for utilities, helpers)
|
|
132
|
-
|
|
133
|
-
Adapt section names to fit the content being documented.
|
|
134
|
-
|
|
135
|
-
# Parallel Processing
|
|
136
|
-
|
|
137
|
-
When processing multiple URLs or files:
|
|
138
|
-
1. Create one Task agent per item (up to reasonable limits)
|
|
139
|
-
2. Launch all tasks in a single message for parallel execution
|
|
140
|
-
3. Wait for all tasks to complete before synthesis
|
|
141
|
-
4. If there are too many items (>50), process in batches
|
|
142
|
-
|
|
143
|
-
# Error Handling
|
|
144
|
-
|
|
145
|
-
- If a URL cannot be scraped, note it and continue with others
|
|
146
|
-
- If a file cannot be read, note it and continue with others
|
|
147
|
-
- Always generate a llms.txt file even if some sources fail
|
|
148
|
-
- Include a note in the output about any failures
|
|
149
|
-
|
|
150
|
-
# Output
|
|
151
|
-
|
|
152
|
-
Always write the generated llms.txt to a file named `llms.txt` in the current directory or a location specified by the user.
|
|
153
|
-
|
|
154
|
-
Provide a summary of:
|
|
155
|
-
- Number of sources processed
|
|
156
|
-
- Number of sections created
|
|
157
|
-
- Any errors or warnings
|
|
158
|
-
- Location of the generated file
|
|
159
|
-
|
|
160
|
-
# Important Constraints
|
|
161
|
-
|
|
162
|
-
- Never use emojis in the generated llms.txt file
|
|
163
|
-
- Keep descriptions concise and technical
|
|
164
|
-
- Prioritize clarity and usefulness for LLMs
|
|
165
|
-
- Follow the user's specific requirements if they provide any customization requests
|