| name | ir |
| description | Local markdown search engine CLI. Use when searching notes, querying documents, managing collections, indexing, embedding, or retrieving document content. Also use when ir search, ir update, ir embed, ir collection, ir status, ir daemon, ir get. |
| allowed-tools | Bash(ir:*) |
ir - Local Markdown Search Engine
๋ก์ปฌ ๋งํฌ๋ค์ด ๋ฌธ์๋ฅผ ์ธ๋ฑ์ฑํ๊ณ ๊ฒ์ํ๋ CLI ๋๊ตฌ. Collection ๊ธฐ๋ฐ ๊ด๋ฆฌ, BM25/Vector/Hybrid ๊ฒ์ ์ง์.
Status
!ir status 2>/dev/null || echo "ir not available"
CLI Quick Reference
Search
ir search "question"
ir search --mode bm25 "keywords"
ir search --mode vector "question"
Search Options
--mode <MODE>
-n <num>
--min-score <num>
-c, --collection <name>
--full
--files
--json
--md
--csv
--all
-v, --verbose
Document Retrieval
ir get "#abc123"
ir get notes/meeting.md:50 -l 100
Collection Management
ir collection list
ir collection add ~/notes --name notes
ir collection remove <name>
ir collection rename <old> <new>
ir collection set-path <name> <path>
Indexing & Embedding
ir update
ir update <collection>
ir update --pull
ir embed
ir embed <collection>
Daemon & MCP
ir daemon start
ir daemon stop
ir daemon status
ir mcp
ir mcp --http <PORT>
Examples
๋
ธํธ์์ ์ ๋ณด ๊ฒ์
User: "๋ฐฐํฌ ๊ด๋ จ ๋
ธํธ ์ฐพ์์ค"
-> ir search "๋ฐฐํฌ ๋ฐฉ๋ฒ deploy" -n 10
-> ๊ฒฐ๊ณผ ์์ฝ -> ํ์ ์ ir get "#docid"๋ก ์์ธ ์กฐํ
์ปฌ๋ ์
์ถ๊ฐ ํ ์ธ๋ฑ์ฑ
User: "์ด ํ๋ก์ ํธ ๋ฌธ์๋ ๊ฒ์๋๊ฒ ํด์ค"
-> ir collection add ~/pj-foo/docs --name pj-foo
-> ir update pj-foo && ir embed pj-foo
-> ir status ๋ก ํ์ธ
ํน์ ์ปฌ๋ ์
์ค์ฝํ ๊ฒ์
User: "ํ์๋ก์์ ํ๋ก์ ํธ ํ์๋ผ์ธ ์ฐพ์์ค"
-> ir search "ํ๋ก์ ํธ ์ผ์ ๊ณผ ๋ง์ผ์คํค" -c meetings -n 10
Principles
- ๊ฒ์ ๋ชจ๋: ๋น ๋ฅธ ํค์๋ ->
--mode bm25, ์ต๊ณ ํ์ง -> ๊ธฐ๋ณธ hybrid
- ์ ์ ํด์: 0.8+ ๋งค์ฐ ๊ด๋ จ, 0.5-0.8 ์ ๋น, 0.5 ๋ฏธ๋ง ์ฝํจ
- ์ปฌ๋ ์
์ค์ฝํ:
-c ์ต์
์ผ๋ก ๋ฒ์๋ฅผ ์ขํ๋ฉด ๋
ธ์ด์ฆ ๊ฐ์
- ์ธ๋ฑ์ค ๊ฐฑ์ : ๋ฌธ์ ์ถ๊ฐ/์์ ํ
ir update && ir embed ์คํ
- ํ์ดํ๋ผ์ธ:
--json/--files ์ถ๋ ฅ์ผ๋ก ํ์ฒ๋ฆฌ ์ฐ๊ฒฐ