ck
Local first semantic and hybrid BM25 grep / search tool for use by AI and humans!
File Explorer
Download Latest Version (.zip)- ci.yaml
- deploy-docs.yml
- release.yml
- dependabot.yml
- .gitkeep
- .gitkeep
- summary.md
- README.md
- requirements.txt
- run.py
- .gitignore
- README.md
- debug_chunks.rs
- tags.scm
- tags.scm
- tags.scm
- tags.scm
- tags.scm
- tags.scm
- tags.scm
- tags.scm
- tags.scm
- tags.scm
- tags.scm
- tags.scm
- tags.scm
- tags.scm
- lib.rs
- query_chunker.rs
- markdown_breadcrumbs.md
- Cargo.toml
- mod.rs
- cache.rs
- context.rs
- errors.rs
- mod.rs
- session.rs
- lib.rs
- main.rs
- mcp_server.rs
- path_utils.rs
- progress.rs
- integration_tests.rs
- mcp_tests.rs
- Cargo.toml
- heatmap.rs
- lib.rs
- Cargo.toml
- list_models.rs
- test_mixedbread.rs
- test_nomic.rs
- test_reranking.rs
- lib.rs
- mixedbread.rs
- reranker.rs
- tokenizer.rs
- Cargo.toml
- lib.rs
- semantic_v3.rs
- Cargo.toml
- lib.rs
- Cargo.toml
- lib.rs
- Cargo.toml
- app.rs
- chunks.rs
- colors.rs
- commands.rs
- config.rs
- events.rs
- lib.rs
- preview.rs
- rendering.rs
- state.rs
- utils.rs
- Cargo.toml
- ck-icon.svg
- cliAdapter.ts
- extension.ts
- mcpAdapter.ts
- searchPanel.ts
- types.ts
- main.js
- styles.css
- .gitignore
- .vscodeignore
- GETTING_STARTED.md
- install-cursor.sh
- LICENSE
- LICENSE-APACHE
- LICENSE-MIT
- package-lock.json
- package.json
- README.md
- tsconfig.json
- ck.js
- npm-distribution.md
- settings.local.json
- custom.css
- index.ts
- config.ts
- development.md
- release-process.md
- testing.md
- editor-integration.md
- grep-compatibility.md
- hybrid-search.md
- mcp-integration.md
- semantic-search.md
- tui-mode.md
- advanced-usage.md
- ai-agent-setup.md
- basic-usage.md
- changelog.md
- choosing-interface.md
- faq.md
- installation.md
- introduction.md
- limitations.md
- roadmap.md
- AGENTS.md
- favicon.png
- logo.png
- ai-workflows.md
- debug-production.md
- explore-codebase.md
- find-auth.md
- refactor-patterns.md
- security-review.md
- advanced.md
- architecture.md
- cli.md
- configuration.md
- models.md
- output-formats.md
- .gitignore
- index.md
- package.json
- pnpm-lock.yaml
- README.md
- api_client.js
- depth_test.rs
- full_section_demo.py
- large_function.py
- sample.rb
- sample.rs
- user_service.go
- web_server.rs
- 2212.10496.pdf
- 2310.03714.pdf
- demo1.txt
- demo10.txt
- demo2.txt
- demo3.txt
- demo4.txt
- demo5.txt
- demo6.txt
- demo7.txt
- demo8.txt
- demo9.txt
- Algorithm.txt
- Art.txt
- Artificial_intelligence.txt
- Biology.txt
- Chemistry.txt
- Computer_science.txt
- Data_science.txt
- Database.txt
- Geography.txt
- History.txt
- JavaScript.txt
- Literature.txt
- Machine_learning.txt
- Mathematics.txt
- Music.txt
- Philosophy.txt
- Physics.txt
- Python_programming_language.txt
- Rust_programming_language.txt
- Statistics.txt
- haskell_sample.hs
- quick_demo.sh
- README.md
- install.js
- test.js
- .gitignore
- .npmignore
- Cargo.lock
- Cargo.toml
- CHANGELOG.md
- CLAUDE.md
- EXAMPLES.md
- LICENSE-APACHE
- LICENSE-MIT
- package.json
- PRD.txt
- README.md
- TUI.md
- UNEXPECTED.md
- vscode_prd.md
# Installation Guide
git clone https://github.com/BeaconBay/ck
Downloads the entire project code from GitHub to your computer.
cd ck
Moves into the project folder you just downloaded.
2. Official Install Script
Easy Recommended- Rust (rustup) Rust is required to use cargo.
- Homebrew A package manager for macOS/Linux.
cargo install ck-search
Builds and installs the package published on crates.io β no need to clone the repo yourself.
cargo install --path ck-cli
Type this command into your terminal and run it.
cargo install ck-search # β
Available now via crates.io
Builds and installs the package published on crates.io β no need to clone the repo yourself.
brew install ck-search # π§ In development (use cargo for now)
Installs the pre-built package via Homebrew β no source build required.
Pulled directly from this repo's README.
3. Node.js
Easycd ck-vscode
This project's files live in a subfolder, so move into it first.
npm install
Downloads and installs the libraries listed in package.json.
npm start
Starts the development/run server.
4. Python
Easypip install -r benchmarks/swe-bench/requirements.txt
Installs the Python libraries listed in requirements.txt (or similar).
python <μ€νν νμΌλͺ
>.py # READMEμμ μ νν μ€ν νμΌλͺ
μ νμΈνμΈμ
Runs the Python script (or module).
5. Rust
Medium- Git Needed to download the project code from GitHub.
- Rust (rustup) Installing via rustup also installs cargo.
cargo install ck-search
Builds and installs the package published on crates.io β no need to clone the repo yourself.
cargo install --path ck-cli
Type this command into your terminal and run it.
cargo install ck-search # β
Available now via crates.io
Builds and installs the package published on crates.io β no need to clone the repo yourself.
brew install ck-search # π§ In development (use cargo for now)
Installs the pre-built package via Homebrew β no source build required.
cargo test --workspace
Type this command into your terminal and run it.
Pulled directly from this repo's README.