# Ck

> ck aims to revolutionize how developers search through codebases by enabling semantic understanding — finding relevant code even when exact keywords aren’t present. It integrates with AI agents for intelligent code navigation, offers a terminal UI for interactive exploration, and supports hybrid keyword-semantic searches. The tool is designed for both manual use and automation, with strong focus on performance, offline operation, and extensibility across languages and platforms.

**Remember:**
- Semantic search
- Hybrid search
- Chunk-level indexing
- MCP (Model Context Protocol)
- TUI (Terminal User Interface)
- Embedding models (e.g., BGE-Small, Nomic V1.5, Jina Code)

## Docs
- [README](https://github.com/BeaconBavy/ck/blob/main/docs-site/README.md): install & quickstart.
- [Installation](https://github.com/BeaconBay/ck/blob/main/docs-site/guide/installation.md): install & quickstart.
- [Docs Site](https://github.com/BeaconBay/ck/blob/main/docs-site/index.md): docs page.
- [Getting Started](https://github.com/BeaconBay/ck/blob/main/ck-vscode/GETTING_STARTED.md): docs page.
- [Advanced](https://github.com/BeaconBay/ck/blob/main/docs-site/reference/advanced.md): API reference.
- [Advanced Usage](https://github.com/BeaconBay/ck/blob/main/docs-site/guide/advanced-usage.md): docs page.
- [Agents](https://github.com/BeaconBay/ck/blob/main/docs-site/public/AGENTS.md): docs page.
- [Ai Agent Setup](https://github.com/BeaconBay/ck/blob/main/docs-site/guide/ai-agent-setup.md): docs page.
- [Ai Workflows](https://github.com/BeaconBay/ck/blob/main/docs-site/recipes/ai-workflows.md): docs page.
- [Architecture](https://github.com/BeaconBay/ck/blob/main/docs-site/reference/architecture.md): API reference.

## Tutorials
- [README](https://github.com/BeaconBay/ck/blob/main/examples/README.md): install & quickstart.
- [Examples](https://github.com/BeaconBay/ck/blob/main/EXAMPLES.md): worked example.
- [Api Client](https://github.com/BeaconBay/ck/blob/main/examples/code/api_client.js): API reference.
- [Full Section Demo](https://github.com/BeaconBay/ck/blob/main/examples/code/full_section_demo.py): worked example.
- [Large Function](https://github.com/BeaconBay/ck/blob/main/examples/code/large_function.py): worked example.
- [Algorithm](https://github.com/BeaconBay/ck/blob/main/examples/text_samples/wiki_articles/Algorithm.txt): worked example.
- [Art](https://github.com/BeaconBay/ck/blob/main/examples/text_samples/wiki_articles/Art.txt): worked example.
- [Artificial Intelligence](https://github.com/BeaconBay/ck/blob/main/examples/text_samples/wiki_articles/Artificial_intelligence.txt): worked example.
- [Biology](https://github.com/BeaconBay/ck/blob/main/examples/text_samples/wiki_articles/Biology.txt): worked example.
- [Chemistry](https://github.com/BeaconBay/ck/blob/main/examples/text_samples/wiki_articles/Chemistry.txt): worked example.

## Optional
- [Changelog](https://github.com/BeaconBay/ck/blob/main/CHANGELOG.md): version history.
- [Claude](https://github.com/BeaconBay/ck/blob/main/CLAUDE.md): docs page.
- [Prd](https://github.com/BeaconBay/ck/blob/main/PRD.txt): docs page.
- [README](https://github.com/BeaconBay/ck/blob/main/README.md): docs page.
- [Tui](https://github.com/BeaconBay/ck/blob/main/TUI.md): docs page.
- [Unexpected](https://github.com/BeaconBay/ck/blob/main/UNEXPECTED.md): docs page.
- [Vscode Prd](https://github.com/BeaconBay/ck/blob/main/vscode_prd.md): docs page.

## Ck Vscode
- [README](https://github.com/BeaconBay/ck/blob/main/ck-vscode/README.md): install & quickstart.
- [Cliadapter](https://github.com/BeaconBay/ck/blob/main/ck-vscode/src/cliAdapter.ts): docs page.
- [Extension](https://github.com/BeaconBay/ck/blob/main/ck-vscode/src/extension.ts): docs page.
- [Main](https://github.com/BeaconBay/ck/blob/main/ck-vscode/webview/main.js): docs page.
- [Mcpadapter](https://github.com/BeaconBay/ck/blob/main/ck-vscode/src/mcpAdapter.ts): docs page.
- [Searchpanel](https://github.com/BeaconBay/ck/blob/main/ck-vscode/src/searchPanel.ts): docs page.
- [Types](https://github.com/BeaconBay/ck/blob/main/ck-vscode/src/types.ts): docs page.
