Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dustinblackman/oatmeal
Terminal UI to chat with large language models (LLM) using different model backends, and integrations with your favourite editors!
https://github.com/dustinblackman/oatmeal
chat cli developer-experiance large-language-models llm oatmeal rust terminal-ui tui
Last synced: 3 months ago
JSON representation
Terminal UI to chat with large language models (LLM) using different model backends, and integrations with your favourite editors!
- Host: GitHub
- URL: https://github.com/dustinblackman/oatmeal
- Owner: dustinblackman
- License: mit
- Created: 2023-11-06T01:19:04.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-03-16T22:50:57.000Z (3 months ago)
- Last Synced: 2024-03-16T23:56:35.879Z (3 months ago)
- Topics: chat, cli, developer-experiance, large-language-models, llm, oatmeal, rust, terminal-ui, tui
- Language: Rust
- Homepage: https://dustinblackman.com/posts/oatmeal/
- Size: 1.78 MB
- Stars: 315
- Watchers: 9
- Forks: 18
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-stars - oatmeal
- my-awesome-starred - dustinblackman/oatmeal - Terminal UI to chat with large language models (LLM) using different model backends, and integrations with your favourite editors! (Rust)
- awesome-ratatui - Oatmeal - Terminal UI to chat with large language models (LLM) using different model backends, and integrations with your favourite editors! (💻 Apps / ⌨️ Development Tools)
- my-awesome-stars - dustinblackman/oatmeal - Terminal UI to chat with large language models (LLM) using different model backends, and integrations with your favourite editors! (Rust)
README
Oatmeal
[](https://github.com/dustinblackman/oatmeal/actions)
[](https://github.com/dustinblackman/oatmeal/releases)
[](https://coveralls.io/github/dustinblackman/oatmeal?branch=main)
> Terminal UI to chat with large language models (LLM) using different model backends, and integrations with your favourite [editors](#editors)!
- [Overview](#Overview)
- [Install](#Install)
- [MacOS](#macos)
- [Debian / Ubuntu](#debian--ubuntu)
- [Fedora / CentOS](#fedora--centos)
- [Nix](#nix)
- [Arch Linux](#arch-linux)
- [Alpine Linux](#alpine-linux)
- [Windows](#windows)
- [Cargo](#cargo)
- [Docker](#docker)
- [Manual](#manual)
- [Source](#source)
- [Usage](#Usage)
- [Configuration](#configuration)
- [Backends](#backends)
- [Editors](#editors)
- [Themes](#themes)
- [Sessions](#sessions)
- [Contributing](#contributing)
- [Report an issue](#report-an-issue)
- [Development](#Development)
- [Setup](#setup)
- [Adding a backend](#adding-a-backend)
- [Adding an editor](#adding-an-editor)
- [Adding syntax highlighting for a language](#adding-syntax-highlighting-for-a-language)
- [FAQ](#faq)
- [Why Oatmeal?](#why-oatmeal)
- [License](#license)
## Overview
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.
## Install
### MacOS
```sh
brew install dustinblackman/tap/oatmeal
```
### Debian / Ubuntu
```sh
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
```
### Fedora / CentOS
```sh
dnf config-manager --add-repo https://yum.dustinblackman.com/config.repo
dnf install oatmeal
```
### Nix
```sh
nix-env -f '' -iA nur.repos.dustinblackman.oatmeal
```
### Arch Linux
```sh
yay -S oatmeal-bin
```
### Alpine Linux
```sh
arch=$(uname -a | grep -q aarch64 && echo 'arm64' || echo 'amd64')
curl -L -o oatmeal.apk "https://github.com/dustinblackman/oatmeal/releases/download/v0.12.3/oatmeal_0.12.3_linux_${arch}.apk"
apk add --allow-untrusted ./oatmeal.apk
```
### Windows
**Chocolatey**
```sh
choco install oatmeal --version=0.12.3
```
**Scoop**
```sh
scoop bucket add dustinblackman https://github.com/dustinblackman/scoop-bucket.git
scoop install oatmeal
```
**Winget**
```sh
winget install -e --id dustinblackman.oatmeal
```
### Cargo
```sh
cargo install oatmeal --locked
```
### Docker
```sh
docker run --rm -it ghcr.io/dustinblackman/oatmeal:latest
```
### Manual
Download the pre-compiled binaries and packages from the [releases page](https://github.com/dustinblackman/oatmeal/releases) and
copy to the desired location.
### Source
```sh
git clone https://github.com/dustinblackman/oatmeal.git
cd oatmeal
cargo build --release
mv ./target/release/oatmeal /usr/local/bin/
```
## Usage
The following shows the availabe 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.
```
Terminal UI to chat with large language models (LLM) using different model backends, and direct integrations with your favourite editors!
Version: 0.12.3
Commit: v0.12.3
Usage: oatmeal [OPTIONS] [COMMAND]
Commands:
chat Start a new chat session.
completions Generates shell completions.
config Configuration file options.
manpages Generates manpages and outputs to stdout.
sessions Manage past chat sessions.
help Print this message or the help of the given subcommand(s)
Options:
-b, --backend
The initial backend hosting a model to connect to. [default: ollama] [env: OATMEAL_BACKEND=] [possible values: langchain, ollama, openai]
--backend-health-check-timeout
Time to wait in milliseconds before timing out when doing a healthcheck for a backend. [default: 1000] [env: OATMEAL_BACKEND_HEALTH_CHECK_TIMEOUT=]
-m, --model
The initial model on a backend to consume. Defaults to the first model available from the backend if not set. [env: OATMEAL_MODEL=]
-c, --config-file
Path to configuration file [default: ~/.config/oatmeal/config.toml] [env: OATMEAL_CONFIG_FILE=]
-e, --editor
The editor to integrate with. [default: clipboard] [env: OATMEAL_EDITOR=] [possible values: neovim, clipboard, none]
-t, --theme
Sets code syntax highlighting theme. [default: base16-onedark] [env: OATMEAL_THEME=] [possible values: base16-github, base16-monokai, base16-one-light, base16-onedark, base16-seti]
--theme-file
Absolute path to a TextMate tmTheme to use for code syntax highlighting. [env: OATMEAL_THEME_FILE=]
--lang-chain-url
LangChain Serve API URL when using the LangChain backend. [default: http://localhost:8000] [env: OATMEAL_LANGCHAIN_URL=]
--ollama-url
Ollama API URL when using the Ollama backend. [default: http://localhost:11434] [env: OATMEAL_OLLAMA_URL=]
--open-ai-url
OpenAI API URL when using the OpenAI backend. Can be swapped to a compatible proxy. [default: https://api.openai.com] [env: OATMEAL_OPENAI_URL=]
--open-ai-token
OpenAI API token when using the OpenAI backend. [env: OATMEAL_OPENAI_TOKEN=]
-h, --help
Print help
-V, --version
Print version
CHAT COMMANDS:
- /modellist (/ml) - Lists all available models from the backend.
- /model (/model) [MODEL_NAME,MODEL_INDEX] - Sets the specified model as the active model. You can pass either the model name, or the index from `/modellist`.
- /append (/a) [CODE_BLOCK_NUMBER?] - Appends code blocks to an editor. See Code Actions for more details.
- /replace (/r) [CODE_BLOCK_NUMBER?] - Replaces selections with code blocks in an editor. See Code Actions for more details.
- /copy (/c) [CODE_BLOCK_NUMBER?] - Copies the entire chat history to your clipboard. When a `CODE_BLOCK_NUMBER` is used, only the specified copy blocks are copied to clipboard. See Code Actions for more details.
- /quit /exit (/q) - Exit Oatmeal.
- /help (/h) - Provides this help menu.
CHAT HOTKEYS:
- Up arrow - Scroll up.
- Down arrow - Scroll down.
- CTRL+U - Page up.
- CTRL+D - Page down.
- CTRL+C - Interrupt waiting for prompt response if in progress, otherwise exit.
- CTRL+R - Resubmit your last message to the backend.
CHAT CODE ACTIONS:
When working with models that provide code, and using an editor integration, Oatmeal has the capabilities to read selected code from an editor, and submit model provided code back in to an editor. Each code block provided by a model is indexed with a (NUMBER) at the beginning of the block to make it easily identifiable.
- /append (/a) [CODE_BLOCK_NUMBER?] will append one-to-many model provided code blocks to the open file in your editor.
- /replace (/r) [CODE_BLOCK_NUMBER?] - will replace selected code in your editor with one-to-many model provided code blocks.
- /copy (/c) [CODE_BLOCK_NUMBER?] - Copies the entire chat history to your clipboard. When a `CODE_BLOCK_NUMBER` is used it will append one-to-many model provided code blocks to your clipboard, no matter the editor integration.
The `CODE_BLOCK_NUMBER` allows you to select several code blocks to send back to your editor at once. The parameter can be set as follows:
- `1` - Selects the first code block
- `1,3,5` - Selects code blocks 1, 3, and 5.
- `2..5`- Selects an inclusive range of code blocks between 2 and 5.
- None - Selects the last provided code block.
```
### Configuration
On top of being configurable with command flags and environment variables, Oatmeal is also manageable with a
configuration file such as [this example](./config.example.toml). 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)
```
### Backends
The following model backends are supported:
- [OpenAI](https://chat.openai.com) (Or any compatible proxy/API)
- [Ollama](https://github.com/jmorganca/ollama)
- [LangChain/LangServe](https://python.langchain.com/docs/langserve) (Experimental)
### Editors
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!
- Clipboard (Default)
- None (Disables all editor functionality)
- [Neovim](https://github.com/dustinblackman/oatmeal.nvim)
### Themes
A handful of themes are embedded in the application for code syntax highlighting, defaulting to [OneDark](https://github.com/atom/one-dark-ui). If none suits your needs, Oatmeal supports any Sublime Text/Text Mate
`.tmTheme` file with the `theme-file` configuration option. [base16-textmate](https://github.com/chriskempson/base16-textmate) has plenty to pick from!
### Sessions
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](https://github.com/BurntSushi/ripgrep) and [FZF](https://github.com/junegunn/fzf).
```bash
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](https://github.com/mikefarah/yq) and [jq](https://github.com/jqlang/jq).
```bash
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"
)
}
```
## Contributing
### Report an issue
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.
1. Head over to [releases](https://github.com/dustinblackman/oatmeal/releases) and download the DEBUG package for the
latest release of Oatmeal.
2. Extract the contents of the archive, and `cd` in your terminal inside the archive.
3. Run your command with the arguments provided in the error message prefixing with `RUST_BACKTRACE=1 ./oatmeal **ARGS-HERE**`
4. Copy/paste the output and [open an issue](https://github.com/dustinblackman/oatmeal/issues/new). Include any screenshots you believe will be helpful!
### Development
#### Setup
The following will get you set up with all the necessary tooling to work on Oatmeal.
```sh
cargo install cargo-run-bin
git clone https://github.com/dustinblackman/oatmeal.git
cd oatmeal
cargo cmd setup
```
#### Adding a backend
Each backend implements the [Backend trait](./src/domain/models/backend.rs) in its own infrastructure file. The trait has documentation on what is expected of each method. You can checkout [Ollama](./src/infrastructure/backends/ollama.rs) as an example.
The following steps should be completed to add a backend:
1. Implement trait for new backend.
2. Update the [BackendName](./src/domain/models/backend.rs) enum with your new Backend name.
3. Update the [BackendManager](./src/infrastructure/backends/mod.rs) to provide your new backend.
4. Write tests
#### Adding an editor
Each editor implements the [Editor trait](./src/domain/models/editor.rs) in its own infrastructure file. The trait has documentation on what is expected of each method. You can checkout [Neovim](./src/infrastructure/editors/neovim.rs) as an example.
The following steps should be completed to add an editor:
1. Implement trait for new editor.
2. Update the [EditorName](./src/domain/models/editor.rs) enum with your new Editor name.
3. Update the [EditorManager](./src/infrastructure/editors/mod.rs) to provide your new editor.
4. Write tests
#### Adding syntax highlighting for a language
Syntax highlighting language selection is a tad manual where several languages must be curated and then added to
[`assets.toml`](./assets.toml).
1. Google to find a `.sublime-syntax` project on Github for your language. [bat](https://github.com/sharkdp/bat/tree/master/assets/syntaxes/02_Extra) has many!
2. Update [`assets.toml`](./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`.
3. `rm -rf .caches && cargo build`
4. Test to see highlighting works.
## FAQ
### Why Oatmeal?
I was eating a bowl of oatmeal when I wrote the first commit :shrug:. (They don't let me name things at work anymore...)
## License
[MIT](./LICENSE)