{"id":15856699,"url":"https://github.com/ebenjs/gpt-shell","last_synced_at":"2025-07-15T14:13:17.310Z","repository":{"id":211711504,"uuid":"729626574","full_name":"ebenjs/gpt-shell","owner":"ebenjs","description":"Bring Chat-GPT to the console. Unleash the power of the OpenAI API directly in the terminal.","archived":false,"fork":false,"pushed_at":"2025-01-14T09:32:17.000Z","size":484,"stargazers_count":5,"open_issues_count":6,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-01T17:44:56.705Z","etag":null,"topics":["ai","bash","chatgpt","cmd","collaborate"],"latest_commit_sha":null,"homepage":"https://gptshell-landing-page.vercel.app/","language":"JavaScript","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/ebenjs.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","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":"2023-12-09T20:30:31.000Z","updated_at":"2024-12-26T13:06:19.000Z","dependencies_parsed_at":"2023-12-17T23:19:30.293Z","dependency_job_id":"64b6cfd0-4083-4016-92b4-d04a54e097c6","html_url":"https://github.com/ebenjs/gpt-shell","commit_stats":{"total_commits":37,"total_committers":1,"mean_commits":37.0,"dds":0.0,"last_synced_commit":"9359fd38dd52e5f259f13f126e9e06effab7f0c7"},"previous_names":["ebenjs/gpt-shell"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/ebenjs/gpt-shell","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebenjs%2Fgpt-shell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebenjs%2Fgpt-shell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebenjs%2Fgpt-shell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebenjs%2Fgpt-shell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ebenjs","download_url":"https://codeload.github.com/ebenjs/gpt-shell/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ebenjs%2Fgpt-shell/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265437797,"owners_count":23765136,"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":["ai","bash","chatgpt","cmd","collaborate"],"created_at":"2024-10-05T20:02:31.750Z","updated_at":"2025-07-15T14:13:17.250Z","avatar_url":"https://github.com/ebenjs.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Badges section here. --\u003e\n\n[![npm version](https://badge.fury.io/js/@ebenjs%2Fgpt-shell.svg)](https://badge.fury.io/js/@ebenjs%2Fgpt-shell)\n![Build Status](https://github.com/ebenjs/gpt-shell/actions/workflows/node.js.yml/badge.svg?branch=develop)\n[![Known Vulnerabilities](https://snyk.io/test/github/ebenjs/gpt-shell/badge.svg?targetFile=package.json)](https://snyk.io/test/github/ebenjs/gpt-shell?targetFile=package.json)\n[![License: Apache](https://img.shields.io/badge/License-Apache-yellow.svg)](https://opensource.org/licenses/Apache-2.0)\n\n\u003c!-- Description section here. --\u003e\n\nThe app is a command line client for chat gpt. It allows users to ask gpt questions and receive responses directly in the console. Written in nodejs.\n\n\u003c!-- Table of contents section here. --\u003e\n\n## Table of Contents\n\n- [Table of Contents](#table-of-contents)\n- [Prerequisites](#prerequisites)\n- [Installation](#installation)\n  - [Automatic install on debian based distros](#automatic-install-on-debian-based-distros)\n  - [Manual install from sources](#manual-install-from-sources)\n    - [Common steps](#common-steps)\n    - [Linux and MacOS](#linux-and-macos)\n    - [Windows](#windows)\n- [Usage](#usage)\n- [Configuration](#configuration)\n- [Contributing](#contributing)\n\n## Prerequisites\n\ngpt-shell is a command line tool that can be installed on any operating system. However, it requires any recent version of Node.js to be installed.\n\n\u003c!-- Installation section here. --\u003e\n\n## Installation\n\nChoose your preferred installation method below. Unix based systems (Linux, macOS) users can install gpt-shell via the command line with the following scripts:\n\n### Automatic install on debian based distros\n\n```bash\ncurl -s https://raw.githubusercontent.com/ebenjs/gpt-shell/main/install-scripts/install-script-deb.sh | sudo bash\n```\n\n### Manual install from sources\n\n#### Common steps\n\n```bash\ngit clone https://github.com/ebenjs/gpt-shell.git\ncd gpt-shell\nnpm install\n```\n\n#### Linux and MacOS\n\n```bash\ncp .env.example .env\nsudo chmod +x index.js\nln -s \"$(pwd)/index.js\" /usr/local/bin/gpts\n```\n\n#### Windows\n\nOn windows, first you need to copy the `.env.example` file to `.env`.\n\n```cmd\ncopy .env.example .env\n```\n\nThen you need to create a `gpts.cmd` file in `C:\\Windows\\System32` with the following content:\n\n```cmd\n@echo off\nnode \"C:\\path\\to\\gpt-shell\\index.js\" %*\n```\n\n\u003c!-- Usage section here. --\u003e\n\n## Usage\n\n```bash\ngpts ask -p \"What is the meaning of life?\"\n```\n\n## Configuration\n\n```bash\ngpts config -k YOUR_API_KEY -m MODEL_NAME -u API_URL\n```\n\n`-k` or `--key` is your openai api key.  \n`-m` or `--model` is the model name to use. Default is `gpt-3.5-turbo`.  \n`-u` or `--url` is the url of the gpt server. Default is `https://api.openai.com/v1/chat/completions`.\n\nThe configuration command is needed only once. It will create a `.gpt-shell-config.json` file in current directory. You can edit this file manually if you want to change the configuration.\n\n\u003c!-- Contributing section here. --\u003e\n\n## Contributing\n\nContributions are welcome. Please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\nFor more information, please refer to the [contributing guidelines](./CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febenjs%2Fgpt-shell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Febenjs%2Fgpt-shell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Febenjs%2Fgpt-shell/lists"}