|
1 | | -# Kiro CLI Knowledge Base Search System |
| 1 | +``` |
| 2 | + +-[ kiro-cli-notes ]--------------------------------------+ |
| 3 | + | knowledge base search system for kiro cli developers | |
| 4 | + | semantic search . mcp . ollama . indexdb | |
| 5 | + +---------------------------------------------------------+ |
| 6 | +``` |
| 7 | + |
| 8 | +internal documentation search system for kiro cli developers. semantic search |
| 9 | +across all kiro cli setup patterns, tutorials, and best practices. runs local |
| 10 | +via ollama -- no external api keys required. |
| 11 | + |
| 12 | +--- |
2 | 13 |
|
3 | | -A comprehensive internal documentation search system for Kiro CLI developers, featuring semantic search, advanced filtering, and contextual discovery across all Kiro CLI setup patterns, tutorials, and best practices. |
| 14 | +## features |
4 | 15 |
|
5 | | -## 🚀 Features |
| 16 | +- semantic search via local ollama embeddings (nomic-embed-text) |
| 17 | +- filtering by content type, tags, and source |
| 18 | +- indexdb-based client-side storage -- offline capable |
| 19 | +- real-time updates when content changes |
6 | 20 |
|
7 | | -- **Semantic Search**: AI-powered search using local Ollama embeddings |
8 | | -- **Advanced Filtering**: Filter by content type, tags, and source |
9 | | -- **Contextual Sections**: Quick access to Day 1 Essentials, MCP Setup, Workflows |
10 | | -- **Client-Side Storage**: Fast IndexedDB-based search with offline capability |
11 | | -- **Responsive Design**: Works on desktop and mobile devices |
12 | | -- **Real-time Updates**: Automatic knowledge base updates when content changes |
| 21 | +--- |
13 | 22 |
|
14 | | -## 📁 Repository Structure |
| 23 | +## repository structure |
15 | 24 |
|
16 | 25 | ``` |
17 | | -├── knowledge-base/ # Knowledge base search system |
18 | | -│ ├── mcp-server/ # MCP server with Ollama embeddings |
19 | | -│ ├── export-pipeline/ # Content extraction and processing |
20 | | -│ ├── static-site/ # Web interface and search functionality |
21 | | -│ └── knowledge-bases/ # Organized content storage |
22 | | -├── video-content/ # Video transcripts and analysis |
23 | | -├── docs/ # Setup documentation and guides |
24 | | -├── configs/ # Configuration files |
25 | | -├── agents/ # Custom agent profiles |
26 | | -├── hooks/ # Automation hooks |
27 | | -├── steering/ # Development standards |
28 | | -├── workflows/ # SDLC workflows |
29 | | -├── tools/ # Utility scripts |
30 | | -└── scripts/ # Setup and maintenance scripts |
| 26 | +knowledge-base/ |
| 27 | + mcp-server/ -- mcp server with ollama embeddings |
| 28 | + export-pipeline/ -- content extraction and processing |
| 29 | + static-site/ -- web interface and search |
| 30 | + knowledge-bases/ -- organized content storage |
| 31 | +video-content/ -- video transcripts and analysis |
| 32 | +docs/ -- setup documentation |
| 33 | +configs/ -- configuration files |
| 34 | +agents/ -- custom agent profiles |
| 35 | +hooks/ -- automation hooks |
| 36 | +steering/ -- development standards |
| 37 | +workflows/ -- sdlc workflows |
| 38 | +tools/ -- utility scripts |
| 39 | +scripts/ -- setup and maintenance |
31 | 40 | ``` |
32 | 41 |
|
33 | | -## 🔧 Quick Start |
| 42 | +--- |
34 | 43 |
|
35 | | -### Option 1: Complete Knowledge Base Setup |
| 44 | +## quick start |
| 45 | + |
| 46 | +complete setup: |
36 | 47 | ```bash |
37 | | -# Full setup with search system |
38 | 48 | ./scripts/setup-knowledge-base.sh |
39 | 49 | ``` |
40 | 50 |
|
41 | | -### Option 2: Basic Project Setup |
| 51 | +basic kiro cli only: |
42 | 52 | ```bash |
43 | | -# Basic Kiro CLI setup only |
44 | 53 | ./scripts/setup.sh |
45 | 54 | ``` |
46 | 55 |
|
47 | | -### Option 3: Manual Setup |
| 56 | +manual setup: |
| 57 | + |
| 58 | +1. set up the mcp server: |
48 | 59 | ```bash |
49 | | -# 1. Set up knowledge base search |
50 | 60 | cd knowledge-base/mcp-server |
51 | 61 | npm install && npm run build |
52 | 62 | ollama pull nomic-embed-text |
| 63 | +``` |
53 | 64 |
|
54 | | -# 2. Export content |
| 65 | +2. export content: |
| 66 | +```bash |
55 | 67 | cd ../export-pipeline |
56 | 68 | npm install && node export-knowledge.js |
| 69 | +``` |
57 | 70 |
|
58 | | -# 3. Start search interface |
| 71 | +3. start the search interface: |
| 72 | +```bash |
59 | 73 | cd ../static-site |
60 | 74 | ./start-server.sh |
61 | 75 | ``` |
62 | 76 |
|
63 | | -## 📊 Knowledge Base Stats |
64 | | - |
65 | | -- **48 Content Chunks** indexed with semantic embeddings |
66 | | -- **Content Types**: Setup (16), Video Tutorials (31), Workflows (1) |
67 | | -- **Top Tags**: MCP, Integration, Tutorials, Setup, AWS, Agents |
68 | | -- **Search Capabilities**: Keyword + semantic similarity matching |
69 | | - |
70 | | -## 🎯 Use Cases |
71 | | - |
72 | | -### Day 1 Developer Setup |
73 | | -- Quick access to essential Kiro CLI configuration |
74 | | -- Step-by-step setup guides with cost optimization |
75 | | -- MCP server integration patterns |
76 | | - |
77 | | -### Advanced Development |
78 | | -- SDLC workflow automation |
79 | | -- Custom agent development |
80 | | -- Production deployment strategies |
81 | | - |
82 | | -### Troubleshooting |
83 | | -- Common issues and solutions |
84 | | -- Best practices and standards |
85 | | -- Video tutorial references |
| 77 | +--- |
86 | 78 |
|
87 | | -## 🔍 Search Features |
| 79 | +## knowledge base stats |
88 | 80 |
|
89 | | -- **Contextual Search**: Pre-configured searches for common needs |
90 | | -- **Advanced Filters**: Content type, tags, source filtering |
91 | | -- **Relevance Scoring**: AI-powered result ranking |
92 | | -- **Incremental Updates**: Automatic content synchronization |
| 81 | +- 48 content chunks indexed with semantic embeddings |
| 82 | +- content types: setup (16), video tutorials (31), workflows (1) |
| 83 | +- top tags: mcp, integration, tutorials, setup, aws, agents |
93 | 84 |
|
94 | | -## 📚 Content Sources |
| 85 | +--- |
95 | 86 |
|
96 | | -Based on analysis of 10 professional Kiro CLI tutorial videos: |
97 | | -- AWS re:Invent 2025 presentations |
98 | | -- Community tutorials and best practices |
99 | | -- Real-world implementation examples |
100 | | -- Production deployment patterns |
| 87 | +## content sources |
101 | 88 |
|
102 | | -## 🤝 Attribution |
| 89 | +based on 10 professional kiro cli tutorial videos: |
| 90 | +- aws re:invent 2025 presentations |
| 91 | +- community tutorials and best practices |
| 92 | +- production deployment patterns |
103 | 93 |
|
104 | | -**Content Sources**: Professional Kiro CLI tutorial videos |
105 | | -**Speakers**: Derek & Kieran (AWS), Girish (Cloud Evangelist), Jack Carrington (Blue Collar Coder) |
106 | | -**Repository Maintainer**: Bryan Chasko (@bryanchasko) |
107 | | -**License**: MIT License |
| 94 | +speakers: derek and kieran (aws), girish (cloud evangelist), jack carrington (blue collar coder) |
108 | 95 |
|
109 | | -## 🔗 Related Projects |
| 96 | +--- |
110 | 97 |
|
111 | | -- [Video Transcription Agent](https://github.com/BryanChasko/kiro-cli-custom-agent-screenpal-video-transcription) - Technical implementation for video processing |
| 98 | +## related |
112 | 99 |
|
113 | | -## 📄 License |
| 100 | +[video transcription agent](https://github.com/BryanChasko/kiro-cli-custom-agent-screenpal-video-transcription) -- technical implementation for video processing |
114 | 101 |
|
115 | | -MIT License - See LICENSE file for details. |
| 102 | +style guide: https://github.com/BryanChasko/heraldstack-mcp/blob/main/STYLE_GUIDE.md |
0 commit comments