Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yusufcanb/tlm
Local CLI Copilot, powered by CodeLLaMa. 💻🦙
https://github.com/yusufcanb/tlm
bash codellama llama3 llm powershell zsh
Last synced: about 14 hours ago
JSON representation
Local CLI Copilot, powered by CodeLLaMa. 💻🦙
- Host: GitHub
- URL: https://github.com/yusufcanb/tlm
- Owner: yusufcanb
- License: apache-2.0
- Created: 2024-02-14T12:00:13.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-07-13T22:36:01.000Z (5 months ago)
- Last Synced: 2024-10-29T15:18:04.560Z (about 1 month ago)
- Topics: bash, codellama, llama3, llm, powershell, zsh
- Language: Go
- Homepage:
- Size: 5.25 MB
- Stars: 1,213
- Watchers: 10
- Forks: 39
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - tlm - Local cli copilot, powered by CodeLLaMa Stars:`1.2K`. (Software Packages / DevOps Tools)
README
# tlm - Local CLI Copilot, powered by CodeLLaMa. 💻🦙
> [!TIP]
> Starcoder2 3B model option coming soon to support workstations with limited resources.
[](https://sonarcloud.io/project/overview?id=yusufcanb_tlm)
[](https://github.com/yusufcanb/tlm/releases)
tlm is your CLI companion which requires nothing except your workstation. It uses most efficient and powerful [CodeLLaMa](https://ai.meta.com/blog/code-llama-large-language-model-coding/) in your local environment to provide you the best possible command line suggestions.
## Features
- 💸 No API Key (Subscription) is required. (ChatGPT, Github Copilot, Azure OpenAI, etc.)
- 📡 No internet connection is required.
- 💻 Works on macOS, Linux and Windows.
- 👩🏻💻 Automatic shell detection. (Powershell, Bash, Zsh)
- 🚀 One liner generation and command explanation.
## Installation
Installation can be done in two ways;
- [Installation script](#installation-script) (recommended)
- [Go Install](#go-install)
### Prerequisites
[Ollama](https://ollama.com/) is needed to download to necessary models.
It can be downloaded with the following methods on different platforms.
- On macOs and Windows;
Download instructions can be followed at the following link: [https://ollama.com/download](https://ollama.com/download)
- On Linux;
```bash
curl -fsSL https://ollama.com/install.sh | sh
```
- Or using official Docker images 🐳;
```bash
# CPU Only
docker run -d -v ollama:/root/.ollama -p 11434:11434 --name ollama ollama/ollama
# With GPU (Nvidia & AMD)
docker run -d --gpus=all -v ollama:/root/.ollama -p 11434:11434 --name ollama ollama/ollama
```
### Installation Script
Installation script is the recommended way to install tlm.
It will recognize the which platform and architecture to download and will execute install command for you.
#### Linux and macOS;
Download and execute the installation script by using the following command;
```bash
curl -fsSL https://raw.githubusercontent.com/yusufcanb/tlm/1.1/install.sh | sudo -E bash
```
#### Windows (Powershell 5.1 or higher)
Download and execute the installation script by using the following command;
```powershell
Invoke-RestMethod -Uri https://raw.githubusercontent.com/yusufcanb/tlm/1.1/install.ps1 | Invoke-Expression
```
### Go Install
If you have Go 1.21 or higher installed on your system, you can easily use the following command to install tlm;
```bash
go install github.com/yusufcanb/tlm@latest
```
Then, deploy tlm modelfiles.
> :memo: **Note:** If you have Ollama deployed on somewhere else. Please first run `tlm config` and configure Ollama host.
```bash
tlm deploy
```
Check installation by using the following command;
```bash
tlm help
```
## Uninstall
On Linux and macOS;
```bash
rm /usr/local/bin/tlm
```
On Windows;
```powershell
Remove-Item -Recurse -Force "C:\Users\$env:USERNAME\AppData\Local\Programs\tlm"
```
## Contributors
