{"id":13620588,"url":"https://github.com/hunterunger/gpt-cli-assistant","last_synced_at":"2025-04-14T21:31:36.684Z","repository":{"id":146409848,"uuid":"584539985","full_name":"hunterunger/gpt-cli-assistant","owner":"hunterunger","description":"Run terminal commands with GPT-3 Codex","archived":false,"fork":false,"pushed_at":"2023-03-23T23:55:54.000Z","size":1759,"stargazers_count":24,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-01T21:44:41.433Z","etag":null,"topics":["ai","bash","cli","fish-shell","github-copilot","gpt-3","shell","terminal","zsh"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hunterunger.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-01-02T21:27:55.000Z","updated_at":"2024-08-01T21:44:41.434Z","dependencies_parsed_at":"2024-01-14T08:06:31.655Z","dependency_job_id":null,"html_url":"https://github.com/hunterunger/gpt-cli-assistant","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hunterunger%2Fgpt-cli-assistant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hunterunger%2Fgpt-cli-assistant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hunterunger%2Fgpt-cli-assistant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hunterunger%2Fgpt-cli-assistant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hunterunger","download_url":"https://codeload.github.com/hunterunger/gpt-cli-assistant/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223648019,"owners_count":17179370,"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","cli","fish-shell","github-copilot","gpt-3","shell","terminal","zsh"],"created_at":"2024-08-01T21:00:57.445Z","updated_at":"2024-11-08T07:30:40.898Z","avatar_url":"https://github.com/hunterunger.png","language":"Python","funding_links":[],"categories":["ai","zsh"],"sub_categories":[],"readme":"# GPT-CLI-Assistant\n## Use AI to make terminal commands!\nAlways forgetting how to use the terminal like me? Well no more!\n\n![screencap.gif](assets/screencap.gif)\n\n## Requirements\n\n* Basic shell knowledge\n* Python 3\n* Mac or Linux\n* Bash, Zsh, or Fish\n\n\n## Quick Start 🏎️\n\nRun the following:\n```\ngit clone https://github.com/hunterunger/gpt-cli-assistant.git\ncd gpt-cli-assistant\npython3 -m pip install -r requirements.txt\npython3 main.py \"check what shell im using\"\n```\n\nIt will then prompt you to set up your API key with [OpenAI](https://openai.com/api/).\n\nAlso, it will give you an alias snippet for Alias Setup. \n\nIf you get an output like `echo $SHELL`, it's working!\n\n## Alias Setup 🔩\n\n### Set up your alias\n\nRun `echo $SHELL` to check your shell.\nThen run `echo $PWD` to get it's absolute path or use the snippet from earlier.\n\n#### If you're using BASH:\n\n```\necho 'alias gpt=\"python3 ~/path/to/main.py\"' \u003e\u003e .bashrc \n```\n\n#### If you're using ZSH:\n\n```\necho 'alias gpt=\"python3 ~/path/to/main.py\"' \u003e\u003e .zshrc \n```\n\n#### If you're using FISH:\n\n```\nfunction gpt\n    python3 ~/path/to/main.py $argv\nend\nfuncsave gpt\n```\n\n---\n\nNow you should be able to run\n```\ngpt \"check what shell I'm using\"\n```\n\n# Usage 🥧\n\n### Simple usage:\n\n`gpt \"your request in simple english\"`\n\nThis will simply output the command to accomplish the requested task.\n![simple_example.png](assets/simple_example.png)\n\n### Automatic Execution\n\nAdd `-e` to automatically run the command.\n\n`gpt \"your request in simple english\" -e`\n\nThis will run the command instantly. \n\n![exe_example.png](assets/exe_example.png)\n### More help\n\nRun `gpt -h` to get more commands and info.\n\n![help.png](assets/help.png)\n## Tips 😎\n\n* Questions are cached so you can re-run the same command without using additional api requests\n* Make commands like `gpt \"list hidden files\"` and NOT like `gpt \"make a command to list files\"`\n* Try long, multi-step commands like `gpt \"save commit history to a file, then search the file for a commit with the word 'beta', then open it in vim\"`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhunterunger%2Fgpt-cli-assistant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhunterunger%2Fgpt-cli-assistant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhunterunger%2Fgpt-cli-assistant/lists"}