{"id":13432457,"url":"https://github.com/yusufcanb/tlm","last_synced_at":"2025-05-16T03:03:39.746Z","repository":{"id":223580991,"uuid":"757391957","full_name":"yusufcanb/tlm","owner":"yusufcanb","description":"Local CLI Copilot, powered by Ollama. 💻🦙","archived":false,"fork":false,"pushed_at":"2025-03-28T14:05:43.000Z","size":9850,"stargazers_count":1415,"open_issues_count":6,"forks_count":48,"subscribers_count":11,"default_branch":"main","last_synced_at":"2025-05-11T01:04:15.086Z","etag":null,"topics":["bash","deepseek-r1","llama3","llm","phi4","powershell","qwen2-5","zsh"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yusufcanb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-02-14T12:00:13.000Z","updated_at":"2025-05-09T21:02:48.000Z","dependencies_parsed_at":"2024-03-01T13:41:58.726Z","dependency_job_id":"bccadeb3-442c-4ae1-a85c-a1346fb4a726","html_url":"https://github.com/yusufcanb/tlm","commit_stats":{"total_commits":152,"total_committers":6,"mean_commits":"25.333333333333332","dds":"0.046052631578947345","last_synced_commit":"011058488d1b1763a28845c586bcf1140acd319d"},"previous_names":["yusufcanb/tlm"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusufcanb%2Ftlm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusufcanb%2Ftlm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusufcanb%2Ftlm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yusufcanb%2Ftlm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yusufcanb","download_url":"https://codeload.github.com/yusufcanb/tlm/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253660887,"owners_count":21943826,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","deepseek-r1","llama3","llm","phi4","powershell","qwen2-5","zsh"],"created_at":"2024-07-31T02:01:11.885Z","updated_at":"2025-05-16T03:03:34.736Z","avatar_url":"https://github.com/yusufcanb.png","language":"Go","funding_links":[],"categories":["Go","Software Packages","Vibe Coding","A01_文本生成_文本对话","bash","软件包","Go Tools"],"sub_categories":["DevOps Tools","大语言对话模型及数据","DevOps 工具"],"readme":"# tlm - Local CLI Copilot, powered by Ollama. 💻🦙\n\n![Latest Build](https://img.shields.io/github/actions/workflow/status/yusufcanb/tlm/build.yaml?style=for-the-badge\u0026logo=github)\n[![Sonar Quality Gate](https://img.shields.io/sonar/quality_gate/yusufcanb_tlm?server=https%3A%2F%2Fsonarcloud.io\u0026style=for-the-badge\u0026logo=sonar)](https://sonarcloud.io/project/overview?id=yusufcanb_tlm)\n[![Latest Release](https://img.shields.io/github/v/release/yusufcanb/tlm?display_name=release\u0026style=for-the-badge\u0026logo=github\u0026link=https%3A%2F%2Fgithub.com%2Fyusufcanb%2Ftlm%2Freleases)](https://github.com/yusufcanb/tlm/releases)\n\ntlm is your CLI companion which requires nothing except your workstation. It uses most efficient and powerful open-source models like [Llama 3.3](https://ollama.com/library/llama3.3), [Phi4](https://ollama.com/library/phi4), [DeepSeek-R1](https://ollama.com/library/deepseek-r1), [Qwen](https://ollama.com/library/qwen2.5-coder) of your choice in your local environment to provide you the best possible command line assistance.\n\n| Get a suggestion                 | Explain a command                |\n| -------------------------------- | -------------------------------- |\n| ![Suggest](./assets/suggest.gif) | ![Explain](./assets/explain.gif) |\n\n| Ask with context (One-liner RAG) | Configure your favorite model  |\n| -------------------------------- | ------------------------------ |\n| ![Ask](./assets/ask.gif)         | ![Config](./assets/config.gif) |\n\n## Features\n\n- 💸 No API Key (Subscription) is required. (ChatGPT, Claude, Github Copilot, Azure OpenAI, etc.)\n\n- 📡 No internet connection is required.\n\n- 💻 Works on macOS, Linux and Windows.\n\n- 👩🏻‍💻 Automatic shell detection. (Powershell, Bash, Zsh)\n\n- 🚀 One liner generation and command explanation.\n\n- 🖺 No-brainer RAG (Retrieval Augmented Generation)\n\n- 🧠 Experiment any model. ([Llama3](https://ollama.com/library/llama3.3), [Phi4](https://ollama.com/library/phi4), [DeepSeek-R1](https://ollama.com/library/deepseek-r1), [Qwen](https://ollama.com/library/qwen2.5-coder)) with parameters of your choice.\n\n## Installation\n\nInstallation can be done in two ways;\n\n- [Installation script](#installation-script) (recommended)\n- [Go Install](#go-install)\n\n### Installation Script\n\nInstallation script is the recommended way to install tlm.\nIt will recognize the which platform and architecture to download and will execute install command for you.\n\n#### Linux and macOS;\n\nDownload and execute the installation script by using the following command;\n\n```bash\ncurl -fsSL https://raw.githubusercontent.com/yusufcanb/tlm/1.2/install.sh | sudo -E bash\n```\n\n#### Windows (Powershell 5.5 or higher)\n\nDownload and execute the installation script by using the following command;\n\n```powershell\nInvoke-RestMethod -Uri https://raw.githubusercontent.com/yusufcanb/tlm/1.2/install.ps1 | Invoke-Expression\n```\n\n### Go Install\n\nIf you have Go 1.22 or higher installed on your system, you can easily use the following command to install tlm;\n\n```bash\ngo install github.com/yusufcanb/tlm@1.2\n```\n\nYou're ready! Check installation by using the following command;\n\n```bash\ntlm\n```\n\n## Usage\n\n```\n$ tlm\nNAME:\n   tlm - terminal copilot, powered by open-source models.\n\nUSAGE:\n   tlm suggest \"\u003cprompt\u003e\"\n   tlm s --model=qwen2.5-coder:1.5b --style=stable \"\u003cprompt\u003e\"\n\n   tlm explain \"\u003ccommand\u003e\" # explain a command\n   tlm e --model=llama3.2:1b --style=balanced \"\u003ccommand\u003e\" # explain a command with a overrided model\n\n   tlm ask \"\u003cprompt\u003e\" # ask a question\n   tlm ask --context . --include *.md \"\u003cprompt\u003e\" # ask a question with a context\n\nVERSION:\n   1.2\n\nCOMMANDS:\n   ask, a      Asks a question (beta)\n   suggest, s  Suggests a command.\n   explain, e  Explains a command.\n   config, c   Configures language model, style and shell\n   version, v  Prints tlm version.\n   help, h     Shows a list of commands or help for one command\n\nGLOBAL OPTIONS:\n   --help, -h     show help\n   --version, -v  print the version\n```\n\n### Ask - Ask something with or without context\n\nAsk a question with context. Here is an example question with a context of this repositories Go files under ask package.\n\n```\n$ tlm ask --help\nNAME:\n   tlm ask - Asks a question (beta)\n\nUSAGE:\n   tlm ask \"\u003cprompt\u003e\" # ask a question\n   tlm ask --context . --include *.md \"\u003cprompt\u003e\" # ask a question with a context\n\nOPTIONS:\n   --context value, -c value                                context directory path\n   --include value, -i value [ --include value, -i value ]  include patterns. e.g. --include=*.txt or --include=*.txt,*.md        \n   --exclude value, -e value [ --exclude value, -e value ]  exclude patterns. e.g. --exclude=**/*_test.go or --exclude=*.pyc,*.pyd\n   --interactive, --it                                      enable interactive chat mode (default: false)\n   --model value, -m value                                  override the model for command suggestion. (default: qwen2 5-coder:3b)\n   --help, -h                                               show help\n```\n\n### Suggest - Get Command by Prompt\n\n```\n$ tlm suggest --help\nNAME:\n   tlm suggest - Suggests a command.\n\nUSAGE:\n   tlm suggest \u003cprompt\u003e\n   tlm suggest --model=llama3.2:1b \u003cprompt\u003e\n   tlm suggest --model=llama3.2:1b --style=\u003cstable|balanced|creative\u003e \u003cprompt\u003e\n\nDESCRIPTION:\n   suggests a command for given prompt.\n\nCOMMANDS:\n   help, h  Shows a list of commands or help for one command\n\nOPTIONS:\n   --model value, -m value  override the model for command suggestion. (default: qwen2.5-coder:3b)\n   --style value, -s value  override the style for command suggestion. (default: balanced)        \n   --help, -h               show help\n```\n\n### Explain - Explain a Command\n\n```\n$ tlm explain --help\nNAME:\n   tlm explain - Explains a command.\n\nUSAGE:\n   tlm explain \u003ccommand\u003e\n   tlm explain --model=llama3.2:1b \u003ccommand\u003e\n   tlm explain --model=llama3.2:1b --style=\u003cstable|balanced|creative\u003e \u003ccommand\u003e\n\nDESCRIPTION:\n   explains given shell command.\n\nCOMMANDS:\n   help, h  Shows a list of commands or help for one command\n\nOPTIONS:\n   --model value, -m value  override the model for command suggestion. (default: qwen2.5-coder:3b)\n   --style value, -s value  override the style for command suggestion. (default: balanced)        \n   --help, -h               show help\n```\n\n## Uninstall\n\nOn Linux and macOS;\n\n```bash\nrm /usr/local/bin/tlm\nrm ~/.tlm.yml\n```\n\nOn Windows;\n\n```powershell\nRemove-Item -Recurse -Force \"C:\\Users\\$env:USERNAME\\AppData\\Local\\Programs\\tlm\"\nRemove-Item -Force \"$HOME\\.tlm.yml\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusufcanb%2Ftlm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyusufcanb%2Ftlm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyusufcanb%2Ftlm/lists"}