https://github.com/krshrimali/context-pilot-rs
Get relevant files/authors for your code - binary written in rust. Plugins available in NeoVim and VSCode (separate repositories)
https://github.com/krshrimali/context-pilot-rs
developer-experience developer-tools git rust
Last synced: 12 days ago
JSON representation
Get relevant files/authors for your code - binary written in rust. Plugins available in NeoVim and VSCode (separate repositories)
- Host: GitHub
- URL: https://github.com/krshrimali/context-pilot-rs
- Owner: krshrimali
- Created: 2023-06-10T06:25:09.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-05T20:49:01.000Z (3 months ago)
- Last Synced: 2025-04-05T21:27:34.497Z (3 months ago)
- Topics: developer-experience, developer-tools, git, rust
- Language: Rust
- Homepage:
- Size: 168 KB
- Stars: 16
- Watchers: 3
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Context Pilot
Just the tool that answers following questions for you:
1. "What all commits ever touched this piece of code?"
2. "What are the files related to this piece of code?"
3. "Who all touched this piece of code?"
Eventually answering following questions for you: (via your own brain or LLMs)
1. "What could have caused the bug?"
2. "Why was this changed in the last month? What's the reason?"
3. "Where can I find the tests written for this code?"
4. "Where should I make the change while working on this code?"
Gist: Whether you want to find:
- **Who** wrote a particular line (author search 🧑💻),
- **Which** files are most related to a given section (context search 📄),
- Or **index** your whole workspace efficiently with Git history 🔥,
Context Pilot gives you **fast**, **powerful**, and **local-first** code intelligence.
## Installation
Context Pilot is available via [homebrew](https://github.com/krshrimali/homebrew-context-pilot):
```shell
brew install krshrimali/context-pilot/context-pilot
```
And via AUR: https://aur.archlinux.org/packages/contextpilot and git package
here: https://aur.archlinux.org/packages/contextpilot-git.
If you're not using homebrew or AUR, please build this project from source for now (we are working on adding this to other package managers):
```bash
git clone https://github.com/krshrimali/context-pilot-rs.git
cd context-pilot-rs
cargo build --release
```
This will generate the binary at `./target/release/contextpilot`.
Move it to a path that's in your `$PATH` to run it globally:
```bash
cp ./target/release/contextpilot /usr/local/bin/contextpilot
```
Once done, you should be able to do: `contextpilot --help`
---
## ✨ Features
- 📈 **History Analysis:** Understand *who* contributed to every line.
- 🔍 **Context Extraction:** Find *related files* automatically based on commit histories.
- 🗂️ **Smart Indexing:** Index your project into a **fast sharded database** for quick queries.
- 🚀 **Rust-Powered:** Extremely **fast** and **lightweight** — no servers needed.
- 🧠 **Multi-level tracing:** Traverses multiple previous commits to capture richer history.
- ⚡ **Editor Integrations:** Works with **Neovim** and **VSCode** extensions.
- 🔒 **Local-first:** Never sends your code outside your machine.
## 🚀 Usage
### Index your workspace
```bash
contextpilot /path/to/workspace -t index
```
This will **index** your project and store smartly sharded JSON database files at:
```bash
~/.context_pilot_db//
```
---
### Selectively Index your Workspace
```
contextpilot /path/to/workspace -t index "subdir1,subdir2"
```
Pass relative paths to the argument as above, and it will only index those
folders for you.
---
### Query for Top Context Files
```bash
contextpilot /path/to/workspace -t query path/to/file.rs -s -e
```
Fetch **top related files** for the selected line range.
---
### Get relevant commits
```bash
contextpilot /path/to/workspace -t desc path/to/file.rs -s -e
```
Gives you the relevant commits to the selected piece of code.
---
## 🖥️ Editor Integrations
### Neovim
- Plugin available: https://github.com/krshrimali/context-pilot.nvim (details available on the link).
### VSCode
- Just search available on VSCode Marketplace with name `contextpilot` under the name of Kushashwa Ravi Shrimali as the publisher :)
- Extension available here: https://github.com/krshrimali/context-pilot-vscode.