codesearch is a simple command-line tool to conduct ngram-based searches on your codebase.
Pull requests are always welcome to introduce new features/changes to codesearch.
Please open an issue on GitHub describing the problem. Please include your platform and any other potentially useful information (too much info is better than not enough!).
Currently, precompiled binaries are unavailable as codesearch is in a very early state and cross-compilation is finicky.
Requirements:
- Cargo
Procedure:
-
Clone or download this repository
-
Navigate to the repository's directory
-
Run
cargo build --release. This will output the binary totarget/release/codesearch. -
Setup the binary to work from the command line
On Unix:
- Copy the binary to
/bin/, or - Create a smylink from
/bin/codesearchto the target directory
On Windows:
- Copy the binary to your preferred destination
- Add the binary to
PATH
- Copy the binary to
codesearch [search term]
This will search the current working directory. If an index does not exist for this directory, one will be created in [YOUR HOME DIRECTORY]/.thearchitect/codesearch.