Terminal UI to chat with large language models (LLM) using different model backends, and integrations with your favourite editors!
Terminal UI to chat with large language models (LLM) using different model backends, and integrations with your favourite editors!
Oatmeal
Terminal UI to chat with large language models (LLM) using different model backends, and integrations with your favourite editors!
Oatmeal is a terminal UI chat application that speaks with LLMs, complete with slash commands and fancy chat bubbles. It features agnostic backends to allow switching between the powerhouse of ChatGPT, or keeping things private with Ollama. While Oatmeal works great as a stand alone terminal application, it works even better paired with an editor like Neovim!
See it in action with Neovim (click to restart):
Note: This project is still quite new, and LLM's can return unexpected answers the UI isn't prepped for. There's likely a few bugs hidden somewhere.
brew install dustinblackman/tap/oatmeal
Note: This method may have outdated releases.
curl -s https://apt.dustinblackman.com/KEY.gpg | apt-key add -
curl -s https://apt.dustinblackman.com/dustinblackman.list > /etc/apt/sources.list.d/dustinblackman.list
sudo apt-get update
sudo apt-get install oatmeal
Note: This method may have outdated releases.
dnf config-manager --add-repo https://yum.dustinblackman.com/config.repo
dnf install oatmeal
nix-env -f '' -iA nur.repos.dustinblackman.oatmeal
yay -S oatmeal-bin
arch=$(uname -a | grep -q aarch64 && echo 'arm64' || echo 'amd64')
curl -L -o oatmeal.apk "https://github.com/dustinblackman/oatmeal/releases/download/v0.13.0/oatmeal_0.13.0_linux_${arch}.apk"
apk add --allow-untrusted ./oatmeal.apk
Chocolatey
choco install oatmeal --version=0.13.0
Scoop
scoop bucket add dustinblackman https://github.com/dustinblackman/scoop-bucket.git
scoop install oatmeal
Winget
winget install -e --id dustinblackman.oatmeal
cargo install oatmeal --locked
docker run --rm -it ghcr.io/dustinblackman/oatmeal:latest
Download the pre-compiled binaries and packages from the releases page and copy to the desired location.
git clone https://github.com/dustinblackman/oatmeal.git
cd oatmeal
cargo build --release
mv ./target/release/oatmeal /usr/local/bin/
The following shows the available options to start a chat session. By default when running oatmeal, Ollama is the selected backend, and the clipboard integration for an editor.
See oatmeal --help, /help in chat, or the output below to get all the details.
…
On top of being configurable with command flags and environment variables, Oatmeal is also manageable with a
configuration file such as this example. You can run oatmeal config create to initialize for
the first time.
Configuration file options.
Usage: oatmeal config [OPTIONS] [COMMAND]
Commands:
create Saves the default config file to the configuration file path. This command will fail if the file exists already.
default Outputs the default configuration file to stdout.
path Returns the default path for the configuration file.
help Print this message or the help of the given subcommand(s)
The following model backends are supported:
The following editors are currently supported. The clipboard editor is a special case where any copy or accept commands
are simply copied to your clipboard. This is the default behaviour. Hit any of the links below for more details on how
to use!
A handful of themes are embedded in the application for code syntax highlighting, defaulting to OneDark. If none suits your needs, Oatmeal supports any Sublime Text/Text Mate
.tmTheme file with the theme-file configuration option. base16-textmate has plenty to pick from!
Oatmeal persists all chat sessions with your models, allowing you to go back and review an old conversation, or pick up from where you left off!
Manage past chat sessions.
Usage: oatmeal sessions [OPTIONS] [COMMAND]
Commands:
dir Print the sessions cache directory path.
list List all previous sessions with their ids and models.
open Open a previous session by ID. Omit passing any session ID to load an interactive selection.
delete Delete one or all sessions.
help Print this message or the help of the given subcommand(s)
Grepping through previous sessions isn't something built in to Oatmeal (yet). This bash function can get you there nicely using Ripgrep and FZF.
function oatmeal-sessions() {
(
cd "$(oatmeal sessions dir)"
id=$(rg --color always -n . | fzf --ansi | awk -F ':' '{print $1}' | head -n1 | awk -F '.' '{print $1}')
oatmeal sessions open --id "$id"
)
}
Or something a little more in depth (while hacky) that additionally uses yq and jq.
function oatmeal-sessions() {
(
cd "$(oatmeal sessions dir)"
id=$(
ls | \
(while read f; do echo "$(cat $f)\n---\n"; done;) | \
yq -p=yaml -o=json - 2> /dev/null | \
jq -s . | \
jq -rc '. |= sort_by(.timestamp) | .[] | "\(.id):\(.timestamp):\(.state.backend_model):\(.state.editor_language):\(.state.messages[] | .text | tojson)"' | \
fzf --ansi | \
awk -F ':' '{print $1}' | \
head -n1 | \
awk -F '.' '{print $1}'
)
oatmeal sessions open --id "$id"
)
}
On each Oatmeal release there is a separate download to help in reporting issues to really drill down in to what the problem is! If you've run in to a problem, I'd really help appreciate solving it.
cd in your terminal inside the archive.RUST_BACKTRACE=1 ./oatmeal **ARGS-HERE**Oatmeal comes with a ready made DevContainer with all the magic needed to work on the project. However if you wish to develop fully local, the following will get you set up with all the necessary tooling.
cargo install cargo-run-bin
git clone https://github.com/dustinblackman/oatmeal.git
cd oatmeal
cargo cmd setup
Each backend implements the Backend trait in its own infrastructure file. The trait has documentation on what is expected of each method. You can checkout Ollama as an example.
The following steps should be completed to add a backend:
Each editor implements the Editor trait in its own infrastructure file. The trait has documentation on what is expected of each method. You can checkout Neovim as an example.
The following steps should be completed to add an editor:
Syntax highlighting language selection is a tad manual where several languages must be curated and then added to
assets.toml.
.sublime-syntax project on GitHub for your language. bat has many!assets.toml to include the new repo. Make sure to include the license in the files array.
You can leave nix-hash as an empty string, and it'll be updated by a maintainer later. Or if you have docker
installed, you can run cargo xtask hash-assets.rm -rf .caches && cargo buildI was eating a bowl of oatmeal when I wrote the first commit :shrug:. (They don't let me name things at work anymore...)
No open issues yet, or sync has not completed.