Codebased is the most powerful code search tool that runs on your computer.
Here's why it's great:
.gitignore
file(s) and ignores hidden directories.The fastest way to install Codebased is with pipx:
pipx install codebased
Verify the installation by running:
codebased --version
If this fails, please double-check your pipx installation.
Next, run the following command in a Git repository to start searching:
codebased search
The first time you run Codebased, it will create a configuration file at ~/.codebased/config.toml
.
It will prompt you for an OpenAI key, you can access a testing key on the Discord.
Once this is finished, codebased
will create an index of your codebase, stored in .codebased
at the root of your
repository.
This takes seconds for most projects, but can take a few minutes for large projects.
Most of the time is spent creating embeddings using the OpenAI API.
Once the index is created, a terminal UI will open with a search bar. At this point, you can start typing a search query and results will appear as you type.
Codebased will run stat
on all non-ignored files in your repository, which can take a few seconds, but after that
will listen for filesystem events, so it's recommended to use the TUI.
If you'd like to contribute, bug fixes are welcome, as well as anything in the list of issues.
Especially welcome is support for your favorite language, as long as:
Also, if there's anything ripgrep does that Codebased doesn't, feel free to file an issue / PR.
Clone the repository:
git clone https://github.com/codebased-sh/codebased.git
Install the project's dependencies (requires poetry, using a virtual environment is recommended):
poetry install
Run the tests (some tests require an OPENAI_API_KEY
environment variable, usage is de minimis):
poetry run pytest