{"id":14175275,"url":"https://github.com/adamyodinsky/TerminalGPT","last_synced_at":"2025-08-07T04:32:30.658Z","repository":{"id":100443943,"uuid":"608755746","full_name":"adamyodinsky/TerminalGPT","owner":"adamyodinsky","description":"TerminalGPT - Terminal-based ChatGPT personal assistant app. Provides optimized, tailored answers for your machine's terminal.","archived":false,"fork":false,"pushed_at":"2025-07-02T05:52:42.000Z","size":1331,"stargazers_count":226,"open_issues_count":17,"forks_count":32,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-07-02T06:37:27.854Z","etag":null,"topics":["ai","assistant","chatgpt","generative-ai","generative-model","gpt","gpt-3","gpt-3-5-turbo","gpt-35-turbo","gpt-4","gpt3-prompts","gptchat","openai","terminal","terminalgpt"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adamyodinsky.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-03-02T17:10:05.000Z","updated_at":"2025-07-02T05:52:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"fbda00b8-290f-45be-8b7f-4b060c1b3015","html_url":"https://github.com/adamyodinsky/TerminalGPT","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"purl":"pkg:github/adamyodinsky/TerminalGPT","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamyodinsky%2FTerminalGPT","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamyodinsky%2FTerminalGPT/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamyodinsky%2FTerminalGPT/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamyodinsky%2FTerminalGPT/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adamyodinsky","download_url":"https://codeload.github.com/adamyodinsky/TerminalGPT/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adamyodinsky%2FTerminalGPT/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269200434,"owners_count":24377432,"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","status":"online","status_checked_at":"2025-08-07T02:00:09.698Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["ai","assistant","chatgpt","generative-ai","generative-model","gpt","gpt-3","gpt-3-5-turbo","gpt-35-turbo","gpt-4","gpt3-prompts","gptchat","openai","terminal","terminalgpt"],"created_at":"2024-08-18T03:01:14.202Z","updated_at":"2025-08-07T04:32:30.649Z","avatar_url":"https://github.com/adamyodinsky.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# ![TerminalGPT](logo.png)\n\n\u003c!--- [![Continuous Integration](https://github.com/adamyodinsky/TerminalGPT/actions/workflows/MainCI.yml/badge.svg?branch=main)](https://github.com/adamyodinsky/TerminalGPT/actions/workflows/main.yml) ---\u003e\n\n![PyPI](https://img.shields.io/pypi/v/terminalgpt) ![PyPI - Downloads](https://img.shields.io/pypi/dm/terminalgpt) ![commits-since](https://img.shields.io/github/commits-since/adamyodinsky/TerminalGPT/latest) ![GitHub last commit](https://img.shields.io/github/last-commit/adamyodinsky/terminalgpt)\n\nWelcome to terminalGPT, the terminal-based ChatGPT personal assistant app!\nWith terminalGPT, you can easily interact with the OpenAI GPT-3.5 and GPT-4 language models.\n\nWhether you need help with a quick question or want to explore a complex topic, TerminalGPT is here to assist you. Simply enter your query and TerminalGPT will provide you with the best answer possible based on its extensive knowledge base.\n\n\u003cimg width=\"910\" alt=\"image\" src=\"https://user-images.githubusercontent.com/27074934/229319537-f332923d-f92e-4d91-8d5e-d26d8997341e.png\"\u003e\n\n### Supported Models\n\n- gpt-3.5-turbo\n- gpt-4-turbo\n- gpt-4o\n- gpt-4o-mini\n- o1\n- o1-mini\n\n## Why?\n\nSome advantages of using TerminalGPT:\n\n- TerminalGPT's answers are tailored to your machine's operating system, distribution, and chip-set architecture.\n- Doesn't use your conversation data for training the model.\n- Your conversations are stored locally on your machine, so only you can access them.\n- Efficient context management for super cheap api usage.\n- It's highly available and can be used whenever you need it.\n- You can use TerminalGPT with your IDE terminal, which means you won't have to constantly switch between your browser and your IDE when you have questions.\n- Fast, reliable, lightweight.\n- Quick one shot question mode.\n\n## Pre-requisites\n\n- Python 3.6 or higher\n- An OpenAI Account and API key.\n  1.  Sign up at \u003chttps://platform.openai.com/signup\u003e using email or Google/Microsoft account.\n  2.  Go to \u003chttps://platform.openai.com/account/api-keys\u003e or click on \"View API keys\" in the menu to get your API key.\n\n## Installation\n\n### Using pip\n\n1. Install the latest TerminalGPT with pip install.\n\n```sh\npip install terminalgpt -U --user\n```\n\nor\n\n```sh\npip3 install terminalgpt -U --user\n```\n\n### Using pipx\n\n1. remove old installation that was installed with pip \u003cbr/\u003e\n   (do this only if you are migrating from a version that was installed with pip)\n\n```sh\npackage_location=$(which terminalgpt)\nrm \"$package_location\"\n```\n\n2. install with pipx\n\n```sh\npipx install terminalgpt==2.2.7 --force\n```\n\n### Setup\n\n1. Now you have `terminalgpt` command available in your terminal. Run the following install command to configure the app.\n\n```sh\nterminalgpt install\n```\n\n2. Enter your OpenAI API key when prompted and press enter.\n\n3. Choose one of the models below as the default model. it can be overridden with the `-m --model` flag later.\n\n4. Choose a printing style\n\nThat's it! You're ready to use TerminalGPT!\nYou can now start a new conversation with `terminalgpt new` or load a previous conversation with `terminalgpt load`. Also you can reinstall with `terminalgpt install` or delete previous conversations with `terminalgpt delete`.\n\n---\n\n## Usage\n\n### TL;DR\n\n```\nUsage: terminalgpt [OPTIONS] COMMAND [ARGS]...\n\n  *~ TerminalGPT - Your Personal Terminal Assistant ~*\n\nOptions:\n  --version                       Show the version and exit.\n  -m, --model [gpt-3.5-turbo|gpt-4-turbo|gpt-4o|gpt-4o-mini|o1|o1-mini]\n                                  Choose a model to use.  [default:\n                                  gpt-4o-mini]\n  -s, --style [markdown|plain]    Output style.  [default: plain]\n  -t, --token-limit INTEGER       Set the token limit. this will override the\n                                  default token limit for the chosen model.\n  --help                          Show this message and exit.\n\nCommands:\n  delete    Choose a previous conversation to delete.\n  install   Installing the OpenAI API key and setup some default settings.\n  load      Choose a previous conversation to load.\n  new       Start a new conversation.\n  one-shot  One shot question answer.\n```\n\n### New\n\nStart a new conversation:\n\n```sh\nterminalgpt new\n```\n\n### One-Shot (I love this feature)\n\nOne shot question to get a fast answer in the terminal.\n\n```sh\nterminalgpt one-shot \"What is the meaning of life?\"\n```\n\n**Note:** I recommend to make an alias, see at [Recommended aliases](#recommended-aliases).\n\n### Load\n\nLoad previous conversations:\n\n```sh\nterminalgpt load\n```\n\n### Delete\n\nDelete previous conversations:\n\n```sh\nterminalgpt delete\n```\n\n## Recommended aliases\n\n### Zsh\n\n```sh\necho alias tgpt=\"terminalgpt\" \u003e\u003e ~/.zshrc\necho alias tgpto=\"terminalgpt one-shot\" \u003e\u003e ~/.zshrc\necho alias tgptn=\"terminalgpt new\" \u003e\u003e ~/.zshrc\n```\n\n### Bash\n\n```sh\necho alias tgpt=\"terminalgpt\" \u003e\u003e ~/.bashrc\necho alias tgpto=\"terminalgpt one-shot\" \u003e\u003e ~/.bashrc\necho alias tgptn=\"terminalgpt new\" \u003e\u003e ~/.bashrc\n```\n\n---\n\n[![Star History Chart](https://api.star-history.com/svg?repos=adamyodinsky/TerminalGPT\u0026type=Date)](https://www.star-history.com/#adamyodinsky/TerminalGPT\u0026Date)\n\n---\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamyodinsky%2FTerminalGPT","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadamyodinsky%2FTerminalGPT","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadamyodinsky%2FTerminalGPT/lists"}