oterm 项目介绍
oterm 是一个以文本为基础的终端客户端,专为与 Ollama 平台整合而设计。它旨在为用户提供一个无需运行服务器或前端界面的直观简便的终端用户界面,使得与智能模型进行交互更为便利。
功能特点
- 简洁的终端界面:用户只需在终端中输入
oterm
即可启动,与复杂的图形界面说再见。 - 多重持久聊天会话:支持多个聊天会话,并将系统提示和参数定制保存在 sqlite 中。
- 模型多样性:用户可以使用从 Ollama 上获取的任何模型或自行创建的定制模型。
- 简便的模型定制:可以轻松定制模型的系统提示和参数。
- 工具集成:支持与工具的集成,为模型提供外部信息。
安装步骤
安装 Ollama
在使用 oterm 之前,用户需要先安装并运行 Ollama 软件。可以参照 Ollama 安装指南。
安装 oterm
-
对于 MacOS 用户,使用
brew
安装:brew tap ggozad/formulas brew install ggozad/formulas/oterm
-
对于 Arch Linux 用户,使用
yay
:yay -S oterm
-
使用
pip
:pip install oterm
更新 oterm
更新方式与安装方式相同:
-
MacOS 用户:
brew upgrade ggozad/formulas/oterm
-
Arch Linux 用户:
yay -Syu oterm
-
使用
pip
:pip install --upgrade oterm
使用方法
在使用 oterm 之前,确保 Ollama 服务器正在运行。默认情况下,oterm 期望 Ollama API 运行在 http://127.0.0.1:11434
。若使用 docker 或不同的主机/端口,可通过设置 OLLAMA_HOST
环境变量进行自定义。
启动 oterm:
oterm
主要命令
通过按下 ^ Ctrl+p 可以访问命令面板,执行大部分的聊天操作。可用的命令有:
- 新建聊天
- 编辑聊天参数
- 重命名聊天
- 导出聊天
- 删除聊天
- 重新生成最后一条 Ollama 消息
- 获取或更新模型
键盘快捷键
支持以下快捷键:
- ^ Ctrl+t - 切换暗/亮主题
- ^ Ctrl+q - 退出
- ^ Ctrl+l - 切换到多行输入模式
- 导航历史记录使用↑键
工具
oterm 支持集成的工具,可以为模型提供外部信息:
date_time
- 当前日期和时间current_location
- 用户当前地理位置current_weather
- 用户所在地的天气信息,需要 OpenWeatherMap API 密钥shell
- 运行 shell 命令并将输出作为模型输入
聊天会话存储
所有聊天会话在本地存储于一个 sqlite 数据库中。可通过 OTERM_DATA_DIR
环境变量自定义数据库目录。
应用配置
配置文件 config.json
存储于操作系统特定的目录中,用户可以通过该文件自定义应用程序的选项。
授权许可
这个项目采用 MIT许可证 授权。