Skip to content

Replace broken ASCII box diagrams with markdown tables in README #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Widthdom merged 1 commit into from
Apr 7, 2026
Merged

Replace broken ASCII box diagrams with markdown tables in README #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 12 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,20 +79,12 @@ On small projects, `grep` works fine. But as a codebase grows to tens of thousan

CodeIndex builds a SQLite database with four main structures:

```
┌─────────────────────────────────────────────────────────┐
│ files │
│ id | path | lang | size | lines | checksum | modified │
├─────────────────────────────────────────────────────────┤
│ chunks │ symbols │
│ file_id | start_line | end_line│ file_id | kind | name│
│ chunk_index | content │ line │
├─────────────────────────────────┴─────────────────────────┤
│ fts_chunks (FTS5 virtual table) │
│ Inverted index over chunks.content │
│ Enables full-text search with MATCH syntax │
└─────────────────────────────────────────────────────────┘
```
| Table | Columns |
|---|---|
| **files** | `id`, `path`, `lang`, `size`, `lines`, `checksum`, `modified` |
| **chunks** | `file_id`, `start_line`, `end_line`, `chunk_index`, `content` |
| **symbols** | `file_id`, `kind`, `name`, `line` |
| **fts_chunks** (FTS5 virtual table) | Inverted index over `chunks.content` — enables full-text search with `MATCH` syntax |

- **`files`** — One row per source file. Stores path, language, size, line count, SHA256 checksum, and modification time. Indexed on `path`, `lang`, and `modified`.
- **`chunks`** — Each file is split into 80-line segments with 10-line overlap. This gives search results with surrounding context, not isolated lines.
Expand Down Expand Up @@ -325,20 +317,12 @@ codeindex /path/to/project --verbose

CodeIndexは4つの主要構造を持つSQLiteデータベースを構築します：

```
┌─────────────────────────────────────────────────────────┐
│ files │
│ id | path | lang | size | lines | checksum | modified │
├─────────────────────────────────────────────────────────┤
│ chunks │ symbols │
│ file_id | start_line | end_line│ file_id | kind | name│
│ chunk_index | content │ line │
├─────────────────────────────────┴─────────────────────────┤
│ fts_chunks (FTS5仮想テーブル) │
│ chunks.contentに対する転置インデックス │
│ MATCH構文による全文検索を実現 │
└─────────────────────────────────────────────────────────┘
```
| テーブル | カラム |
|---|---|
| **files** | `id`, `path`, `lang`, `size`, `lines`, `checksum`, `modified` |
| **chunks** | `file_id`, `start_line`, `end_line`, `chunk_index`, `content` |
| **symbols** | `file_id`, `kind`, `name`, `line` |
| **fts_chunks** (FTS5仮想テーブル) | `chunks.content`に対する転置インデックス — `MATCH`構文による全文検索を実現 |

- **`files`** — ソースファイル1つにつき1行。パス、言語、サイズ、行数、SHA256チェックサム、更新日時を格納。`path`・`lang`・`modified`にインデックスあり。
- **`chunks`** — 各ファイルを80行単位・10行重複で分割。孤立した行ではなく、前後の文脈を含む検索結果を返せる。
Expand Down