Commit d8e005a

mo khan <mo@mokhan.ca>
2026-01-22 04:45:45
docs: add notes on cli tools that elelem uses
1 parent 5154096
Changed files (1)
README.md
@@ -25,6 +25,26 @@ set of built-in tools that give the LLM access to the local file system.
 * Runs inside a Git repository.
 * Git is available and functional.
 
+## Dependencies
+
+Elelem relies on several external tools. Install the ones you need:
+
+| Tool | Purpose | Install |
+|------|---------|---------|
+| [Ollama](https://ollama.ai/) | Default LLM provider | https://ollama.ai/download |
+| [glow](https://github.com/charmbracelet/glow) | Markdown rendering | `brew install glow` / `go install github.com/charmbracelet/glow@latest` |
+| [ctags](https://ctags.io/) | Repo map generation | `brew install universal-ctags` / `apt install universal-ctags` |
+| [ripgrep](https://github.com/BurntSushi/ripgrep) | Text search (`rg`) | `brew install ripgrep` / `apt install ripgrep` |
+| [fd](https://github.com/sharkdp/fd) | File discovery | `brew install fd` / `apt install fd-find` |
+| [ast-grep](https://ast-grep.github.io/) | Structural search (`sg`) | `brew install ast-grep` / `cargo install ast-grep` |
+| [Git](https://git-scm.com/) | Version control | `brew install git` / `apt install git` |
+
+**Required:** Git, Ollama (or another LLM provider)
+
+**Recommended:** glow, ctags, ripgrep, fd
+
+**Optional:** ast-grep (for structural code search)
+
 ## Scope
 
 Only plain-text and source-code files are supported. No binary handling,