v0.1.0

Released: May 5, 2026 · Download

🚀 Initial release

idx v0.1.0 establishes the full core feature set: index initialization, incremental sync, real-time watch, background daemon management, content search with metadata filtering, and interactive inspection.

Features

BM25 indexing engine

  • Per-directory index architecture — each directory maintains its own BM25 inverted index
  • Binary GOB serialization for fast, space-efficient storage on disk
  • Checksum-based incremental sync — only directories whose content changed are re-indexed
  • Automatic removal of directory indexes when no indexable files remain
  • Symlink detection and filtering

CLI commands

Command Description
idx init Build the index for the full project tree
idx sync Re-sync changed directories using checksum diffing
idx watch Monitor the filesystem and sync in real time
idx search Full-text BM25 search with metadata filters
idx inspect Browse and inspect the current index state
idx status Report index freshness and detect unindexed directories
idx destroy Remove the .idx directory and all index data
idx daemon Manage background watch processes

Search capabilities

  • Metadata filtering by file name and path (--file, --path)
  • Pagination via --from and --size
  • JSON output mode (--format json) with structured response
  • Context lines (--context N)
  • Files-only mode (--files-only)
  • Score explanation (--explain)
  • Colored highlights in terminal output
  • Result caching for repeated queries

Real-time watch

Configurable debounce timing. Prints updated file list when --show-updated-files is set.

Background daemon

Long-running index processes managed via idx daemon enable | disable | status. Uses OSProcessSpawner for process lifecycle management.

Architecture

Clean hexagonal architecture from day one:

cmd/idx/          → dependency injection & startup
internal/core/    → domain, ports, services
internal/adapters/ → CLI handlers, TUI, repository

ADRs 0001–0007 document every major architectural decision made in this release.

CI / Release automation

  • GitHub Actions workflow for automated cross-platform binary builds (darwin/linux × amd64/arm64)
  • Dependabot for Go module updates
  • govulncheck and CodeQL security scanning
  • Cyclomatic complexity enforcement via golangci-lint

Known limitations

  • No remote or networked index support
  • Index format may change in minor releases before v1.0