{"id":19450707,"url":"https://github.com/aineejames/chatgpterminator","last_synced_at":"2025-04-05T21:07:01.211Z","repository":{"id":142584778,"uuid":"613561329","full_name":"AineeJames/ChatGPTerminator","owner":"AineeJames","description":"GPTerminator provides a convenient way to interact with OpenAI's chat completion and image generation API's using your command line interface.","archived":false,"fork":false,"pushed_at":"2023-05-21T16:23:03.000Z","size":2741,"stargazers_count":231,"open_issues_count":4,"forks_count":16,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-04-01T15:06:17.508Z","etag":null,"topics":["chatgpt","chatgpt-api","cli","openai","python"],"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/AineeJames.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}},"created_at":"2023-03-13T20:14:49.000Z","updated_at":"2025-03-08T22:09:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"ac9fd1b1-9a29-40dd-a161-9faf0b2e86ee","html_url":"https://github.com/AineeJames/ChatGPTerminator","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AineeJames%2FChatGPTerminator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AineeJames%2FChatGPTerminator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AineeJames%2FChatGPTerminator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AineeJames%2FChatGPTerminator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AineeJames","download_url":"https://codeload.github.com/AineeJames/ChatGPTerminator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247399874,"owners_count":20932876,"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":["chatgpt","chatgpt-api","cli","openai","python"],"created_at":"2024-11-10T16:38:41.040Z","updated_at":"2025-04-05T21:07:01.181Z","avatar_url":"https://github.com/AineeJames.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003eGPTerminator :robot: - ChatGPT in the Terminal!\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"./imgs/panel_output.png\" width=\"600\" /\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003eGPTerminator provides a convenient way to interact with OpenAI's chat completion and image generation APIs using your command line interface.\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://img.shields.io/github/last-commit/AineeJames/ChatGPTerminator?style=for-the-badge\u0026logo=github\u0026color=7dc4e4\u0026logoColor=D9E0EE\u0026labelColor=302D41\" /\u003e\n\u003cimg src=\"https://img.shields.io/github/stars/AineeJames/ChatGPTerminator?style=for-the-badge\u0026logo=apachespark\u0026color=eed49f\u0026logoColor=D9E0EE\u0026labelColor=302D41\" /\u003e\n\u003c/p\u003e\n\n## Features :sparkles:\n\n- :mag: Chat completion\n- :floppy_disk: Save and load chat sessions\n- :bar_chart: File analysis\n- :art: Image generation with Dalle\n- :clipboard: Easy code and text copying using\n- :repeat: Regeneration of responses\n\n## Getting Started \u0026 Installation :rocket:\n\n### To use this terminal interface, follow these steps:\n\n#### 1) Install GPTerminator\n\n```shell\ngit clone https://github.com/AineeJames/ChatGPTerminator\ncd ChatGPTerminator\npip install .\n```\n\nor\n\n```shell\npip install gpterminator\n```\n\n#### 2) Set the OPENAI_API_KEY env variable (you may want this in your shell's `.rc` file):\n\n```shell\nexport OPENAI_API_KEY=\u003cYOUR_API_KEY\u003e\n```\n\n#### 3) Start GPTerminator by running one of the following commands:\n\n```shell\ngpterm\n# or\ngpterm \u003cinput\u003e # ex: gpterm write a hello world function in Python\n```\n\n#### 4) Type `!help` for a list of commands to use\n\n## Running with podman/docker (optional) :package:\n\n#### Build the image and provide the `APIKEY`\n\n```bash\npodman build \\\n\t--build-arg APIKEY=$(echo $OPENAI_API_KEY) \\\n\t-t gpterm .\n```\n\n#### Run `gpterm` in the container\n\n```bash\npodman run -it --rm --name gpterm gpterm\n```\n\n#### Set an alias for easy access\n\n```bash\necho \"alias gpterm='podman run -it --rm --name gpterm gpterm'\" \u003e\u003e ~/.bashrc\n```\n\n## Commands :exclamation:\n\n- Power up you chat experience with commands!\n- By typing `!help` you can view all the possible commands along with a short description.\n- Please check out the [wiki](https://github.com/AineeJames/ChatGPTerminator/wiki/Commands) for more detailed help with commands!\n\n## Configuration :gear:\n\nThe `config.ini` configuration resides in different locations depending on your OS. In order to find the path, run `gpterm` and then enter `!pconf`.\n\nGPTerminator is configurable and can support multiple configurations. Add the following to your `config.ini`:\n\n```ini\n[CONFIG_TEMPLATE]\nModelName =\nSystemMessage =\nTemperature =\nPresencePenalty =\nFrequencyPenalty =\nCommandInitiator =\nSavePath =\nCodeTheme =\n```\n\n| Setting              | Description                                                    | Default                                        |\n| -------------------- | -------------------------------------------------------------- | ---------------------------------------------- |\n| **ModelName**        | this is the model used when chatting                           | `gpt-3.5-turbo`                                |\n| **Temperature**      | between 0 and 2                                                | `1`                                            |\n| **PresencePenalty**  | between -2 and 2                                               | `0`                                            |\n| **FrequencyPenalty** | between -2 and 2                                               | `0`                                            |\n| **SystemMessage**    | this is the starting system message sent to the API            | You are a helpful assistant named GPTerminator |\n| **CommandInitiator** | this can be set to change the default `!` structure            | `!`                                            |\n| **SavePath**         | this changes the location of the save path when loading/saving | (default save path)                            |\n| **CodeTheme**        | this changes the Pygments theme of code blocks                 | `monokai`                                      |\n\n\u003e **Note**\n\u003e More details on some settings can be found [here](https://platform.openai.com/docs/api-reference/chat/create)\n\n\u003e **Note**\n\u003e Valid color schemes can be found [here](https://pygments.org/styles/)\n\n\u003e **Note** If you change the `CommandInitiator`, you will now type `\u003cnew-command\u003e` to execute commands...\n\nAfter saving the config file, run `gpterm`, then enter `!setconf` and select which config you wish to use. You can also run the `!pconf` command to view the current config details.\n\n## Contributing :raised_hands:\n\n### Current Contributors:\n\n\u003ca href=\"https://github.com/AineeJames/ChatGPTerminator/graphs/contributors\"\u003e\n\u003cimg src=\"https://contrib.rocks/image?repo=AineeJames/ChatGPTerminator\" /\u003e\n\u003c/a\u003e\n\nWe welcome contributions to this project. If you find a bug, have a feature request, or want to contribute code, please open an issue or submit a pull request.\n\n## Disclaimer :warning:\n\n\u003e **Warning**\n\u003e This program uses the OpenAI API to chat and generate images using DALL·E. It is a good idea to put a usage cap on your billing, just in case something goes wrong!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faineejames%2Fchatgpterminator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faineejames%2Fchatgpterminator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faineejames%2Fchatgpterminator/lists"}