tlm - 本地 CLI 拍档，由 Ollama 提供支持。💻🦙

tlm 是您的 CLI 伴侣，只需您的工作站即可运行。它在您的本地环境中使用最高效、最强大的开源模型，如 Llama 3.3、Phi4、DeepSeek-R1、Qwen，为您提供最佳的命令行协助。

获取建议	解释命令

带上下文提问（单行 RAG）	配置您喜欢的模型

特性

• 💸 无需 API 密钥（订阅）。（ChatGPT、Claude、Github Copilot、Azure OpenAI 等）

• 📡 无需互联网连接。

• 💻 支持 macOS、Linux 和 Windows。

• 👩🏻‍💻 自动检测 shell。（Powershell、Bash、Zsh）

• 🚀 生成单行命令并解释命令。

• 🖺 简单易用的 RAG（检索增强生成）。

• 🧠 可以尝试任何模型。（Llama3、Phi4、DeepSeek-R1、Qwen）并根据您的需求设置参数。

安装

安装有两种方式：

• 安装脚本（推荐）
• Go Install

安装脚本

推荐使用安装脚本来安装 tlm。 它会自动识别平台和架构进行下载，并为您执行安装命令。

Linux 和 macOS；

使用以下命令下载并执行安装脚本：

curl -fsSL https://raw.githubusercontent.com/yusufcanb/tlm/1.2/install.sh | sudo -E bash

Windows（Powershell 5.5 或更高版本）

使用以下命令下载并执行安装脚本：

Invoke-RestMethod -Uri https://raw.githubusercontent.com/yusufcanb/tlm/1.2/install.ps1 | Invoke-Expression

Go Install

如果您系统上已安装 Go 1.22 或更高版本，可以使用以下命令轻松安装 tlm：

go install github.com/yusufcanb/tlm@1.2

现在您已经准备好了！请使用以下命令检查安装是否成功：

tlm

使用

$ tlm
名称：
   tlm - 终端拍档，基于开源模型。

用法：
   tlm suggest "<prompt>"
   tlm s --model=qwen2.5-coder:1.5b --style=stable "<prompt>"

   tlm explain "<command>" # 解释命令
   tlm e --model=llama3.2:1b --style=balanced "<command>" # 使用覆盖模型解释命令

   tlm ask "<prompt>" # 提问
   tlm ask --context . --include *.md "<prompt>" # 带上下文提问

版本：
   1.2

命令：
   ask, a      提问（测试版）
   suggest, s  建议命令。
   explain, e  解释命令。
   config, c   配置语言模型、风格和 shell
   version, v  打印 tlm 版本。
   help, h     显示命令列表或某个命令的帮助

全局选项：
   --help, -h     显示帮助
   --version, -v  打印版本号

Ask - 带或不带上下文提问

带上下文提问。以下是一个示例，问题的上下文是此仓库中 ask 包下的 Go 文件。

$ tlm ask --help
名称：
   tlm ask - 提问（测试版）

用法：
   tlm ask "<prompt>" # 提问
   tlm ask --context . --include *.md "<prompt>" # 带上下文提问

选项：
   --context value, -c value                                上下文目录路径
   --include value, -i value [ --include value, -i value ]  包含模式。例如 --include=*.txt 或 --include=*.txt,*.md        
   --exclude value, -e value [ --exclude value, -e value ]  排除模式。例如 --exclude=**/*_test.go 或 --exclude=*.pyc,*.pyd
   --interactive, --it                                      启用交互式聊天模式（默认：关闭）
   --model value, -m value                                  覆盖用于命令建议的模型。（默认：qwen2.5-coder:3b）
   --help, -h                                               显示帮助

Suggest - 根据提示获取命令

$ tlm suggest --help
名称：
   tlm suggest - 建议命令。

用法：
   tlm suggest <prompt>
   tlm suggest --model=llama3.2:1b <prompt>
   tlm suggest --model=llama3.2:1b --style=<stable|balanced|creative> <prompt>

描述：
   根据给定的提示建议一个命令。

命令：
   help, h  显示命令列表或某个命令的帮助

选项：
   --model value, -m value  覆盖用于命令建议的模型。（默认：qwen2.5-coder:3b）
   --style value, -s value  覆盖用于命令建议的风格。（默认：balanced）        
   --help, -h               显示帮助

Explain - 解释命令

$ tlm explain --help
名称：
   tlm explain - 解释命令。

用法：
   tlm explain <command>
   tlm explain --model=llama3.2:1b <command>
   tlm explain --model=llama3.2:1b --style=<stable|balanced|creative> <command>

描述：
   解释给定的 shell 命令。

命令：
   help, h  显示命令列表或某个命令的帮助

选项：
   --model value, -m value  覆盖用于命令建议的模型。（默认：qwen2.5-coder:3b）
   --style value, -s value  覆盖用于命令建议的风格。（默认：balanced）        
   --help, -h               显示帮助

卸载

在 Linux 和 macOS 上：

rm /usr/local/bin/tlm
rm ~/.tlm.yml

在 Windows 上：

Remove-Item -Recurse -Force "C:\Users\$env:USERNAME\AppData\Local\Programs\tlm"
Remove-Item -Force "$HOME\.tlm.yml"

tlm 快速上手指南

tlm 是一款基于 Ollama 的本地命令行 AI 助手（Copilot）。它无需 API 密钥、无需联网，即可利用本地大模型为你提供命令建议、解释及上下文问答。

环境准备

在开始之前，请确保满足以下条件：

1. 操作系统：支持 macOS、Linux 或 Windows (PowerShell 5.5+)。
2. 核心依赖：必须安装并运行 Ollama。
   • 安装 Ollama 后，请先拉取一个模型（例如 qwen2.5-coder 或 llama3.3），否则 tlm 无法工作。
   • 示例：ollama pull qwen2.5-coder
3. 可选依赖：若选择通过 Go 安装，需安装 Go 1.22 或更高版本。

国内用户提示：由于 Ollama 官方服务器访问可能受限，建议配置国内镜像源或使用国内加速节点拉取模型。

安装步骤

推荐使用官方安装脚本，它会自动识别你的系统架构并完成安装。

方式一：使用安装脚本（推荐）

Linux / macOS:

curl -fsSL https://raw.githubusercontent.com/yusufcanb/tlm/1.2/install.sh | sudo -E bash

Windows (PowerShell):

Invoke-RestMethod -Uri https://raw.githubusercontent.com/yusufcanb/tlm/1.2/install.ps1 | Invoke-Expression

方式二：使用 Go 安装

如果你已安装 Go 1.22+，可执行：

go install github.com/yusufcanb/tlm@1.2

验证安装

安装完成后，运行以下命令检查是否成功：

tlm

基本使用

tlm 主要提供三个核心功能：命令建议 (suggest)、命令解释 (explain) 和上下文问答 (ask)。

1. 获取命令建议 (Suggest)

告诉 tlm 你想做什么，它会生成对应的 Shell 命令。

# 基础用法
tlm suggest "列出当前目录下所有大于 100MB 的文件"

# 指定模型和风格 (stable/balanced/creative)
tlm s --model=qwen2.5-coder:1.5b --style=stable "查找并删除所有 .log 结尾的空文件"

2. 解释命令 (Explain)

将复杂的命令粘贴给 tlm，它会用自然语言解释其作用。

# 基础用法
tlm explain "grep -r 'error' /var/log | awk '{print $1}' | sort | uniq -c"

# 指定模型
tlm e --model=llama3.2:1b "docker ps -a --filter status=exited --format '{{.ID}}'"

3. 带上下文的问答 (Ask)

基于当前目录或特定文件内容提问（轻量级 RAG 功能）。

# 询问当前目录下的代码逻辑
tlm ask "这个项目是如何处理数据库连接的？"

# 指定上下文范围和文件类型
tlm ask --context . --include *.md "总结 README 中的主要安装步骤"

# 开启交互式对话模式
tlm ask --interactive "帮我优化这段代码"

常用配置

你可以随时修改默认模型、风格或 Shell 设置：

tlm config