# Fnord
[](https://github.com/sysread/fnord/actions/workflows/run-tests.yml)
Fnord is a command line tool the builds a searchable database of your files,
using AI-generated embeddings to index and search your code base, notes, and
other (non-binary) files.
## Installation
1. Install `elixir` if necessary:
```bash
# MacOS
brew install elixir
# Debian-based
sudo apt-get install elixir
```
2. Add the mix escript path to your shell's PATH:
```bash
echo 'export PATH="$HOME/.mix/escripts:$PATH"' >> ~/.bashrc
source ~/.bashrc
```
3. Install the script:
```bash
mix escript.install github sysread/fnord
```
Use the same command to reinstall. It will offer to overwrite the existing
installation.
## Usage
### Indexing
The first time you run this, especially on a large codebase, it will take a
while to index everything. Subsequent runs will be faster, re-indexing only
those files which have changed since they were last indexed.
```bash
fnord index --project foo --dir /path/to/foo
```
You can **reindex** the project, forcing it to reindex all files:
```bash
fnord index --project foo --dir /path/to/foo --reindex
```
You can also watch the project for changes and reindex them as they happen:
```bash
fnord watch --project foo --dir /path/to/foo
```
### Searching
```bash
fnord search --project foo --query "some search query"
```
If you want more detail about each file matched:
```bash
fnord search --project foo --query "some search query" --detail
```
### Ask
You can ask the AI assistant to answer questions about your project:
```bash
fnord ask --project foo --query "how do you run the tests for this project?"
# Continue the conversation
fnord ask --project foo --query "how does the test coverage look to you?" -C
# With status messages emitted to stderr
fnord ask --project foo --query "if the test coverage is so amazing then how come my change didn't break any tests?!" -C -v
# Pipe output to `glow` to render markdown
fnord ask -p foo -q "summarize the dependencies of this project" -v | glow
```
### Miscellaneous
- **List projects:** `fnord projects`
- **List files in a project:** `fnord files --project foo`
- **Show the AI-generated summary of a file:** `fnord summary --project foo --file bar`
- **Delete a project:** `fnord delete --project foo`
Note that deleting a project only deletes from the index, not the actual files.
## TODO
- `ask`: read questions from stdin
