51 lines
1.4 KiB
Markdown
51 lines
1.4 KiB
Markdown
**FIDO** a minimal coding assistant.
|
|
|
|
Fido is a console REPL assistant that inspects files, lists directories, searches file
|
|
contents, applies changes, and runs shell commands (with user approval).
|
|
|
|
## Install
|
|
|
|
Installs into `~/.fido` and adds a `fido` launcher to your `PATH` via `~/.bashrc`:
|
|
|
|
```sh
|
|
git clone <this-repo> ~/src/fidoca
|
|
cd ~/src/fidoca
|
|
./install.sh
|
|
source ~/.bashrc
|
|
```
|
|
|
|
The installer needs the sibling `llmorbiter` checkout (this project depends on it
|
|
via `file:../llmorbiter`); it is bundled into `~/.fido/llmorbiter`. Override its
|
|
location with `LLMORBITER_SRC=/path/to/llmorbiter`.
|
|
|
|
Then, from any project directory:
|
|
|
|
```sh
|
|
fido # work on the current directory
|
|
fido /path/to/project # work on a specific directory
|
|
```
|
|
|
|
Set `OPENROUTER_API_KEY` (and optionally `TAVILY_API_KEY`) in `~/.fido/.env`.
|
|
|
|
### Layout
|
|
|
|
```
|
|
~/.fido/
|
|
app/ the fido app (this repo)
|
|
llmorbiter/ bundled dependency
|
|
bin/fido the launcher (added to PATH)
|
|
.env your config / API keys
|
|
state/<workspace>/ per-workspace state
|
|
undo.json
|
|
suspends/
|
|
```
|
|
|
|
Undo and `/suspend` state is stored **per workspace** under `~/.fido/state/`, so it
|
|
never mixes between projects and never litters your repositories.
|
|
|
|
To remove everything: `./install.sh --uninstall`.
|
|
|
|
## License
|
|
|
|
[0BSD](https://opensource.org/license/0bsd)
|