{"id":18932359,"url":"https://github.com/avicennajr/shellmate","last_synced_at":"2025-04-15T16:33:48.705Z","repository":{"id":129404524,"uuid":"611365437","full_name":"AvicennaJr/ShellMate","owner":"AvicennaJr","description":"Your very own terminal AI assisstant 🤖","archived":false,"fork":false,"pushed_at":"2023-03-08T18:28:41.000Z","size":781,"stargazers_count":29,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T23:43:31.363Z","etag":null,"topics":["ai","artificial-intelligence","artificialintelligence","chatgpt","go","golang","openai-api","openapi","terminal","virtual-assistant"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AvicennaJr.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":"2023-03-08T17:15:18.000Z","updated_at":"2025-03-08T20:00:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"d7fc8c93-570e-4a7e-acf9-385e01f859a1","html_url":"https://github.com/AvicennaJr/ShellMate","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AvicennaJr%2FShellMate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AvicennaJr%2FShellMate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AvicennaJr%2FShellMate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AvicennaJr%2FShellMate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AvicennaJr","download_url":"https://codeload.github.com/AvicennaJr/ShellMate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249108564,"owners_count":21214016,"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","artificial-intelligence","artificialintelligence","chatgpt","go","golang","openai-api","openapi","terminal","virtual-assistant"],"created_at":"2024-11-08T11:48:58.344Z","updated_at":"2025-04-15T16:33:48.699Z","avatar_url":"https://github.com/AvicennaJr.png","language":"Go","readme":"\u003ch1 align=\"center\"\u003eShell Mate 🤖\u003c/h1\u003e\n\u003ch2 align=\"center\"\u003eYour Very Own Terminal AI Assistant\u003c/h2\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/AvicennaJr/ShellMate\"\u003e\u003cimg alt=\"Shell Mate\" src=\"https://img.shields.io/badge/Shell Mate-green\"\u003e\u003c/a\u003e\n    \u003ca href=\"https://github.com/AvicennaJr/ShellMate\"\u003e\u003cimg alt=\"Shell Mate\" src=\"https://img.shields.io/badge/platform-Linux | Windows | Android-green.svg\"\u003e\u003c/a\u003e\n    \u003cimg src=\"https://img.shields.io/badge/Made%20with-Go-1f425f.svg\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/go-mod/go-version/gomods/athens.svg\"\u003e\n\u003c/p\u003e\n\n\n## Demo\n\u003cimg align=\"center\" src=\"./assets/demo.gif\"\u003e\n\n## Getting Started\n- First create an account on [OpenAI](https://platform.openai.com/overview) and create a new [token key](https://platform.openai.com/account/api-keys).\n\n- Place the token key to your environmental variables or you could optionally put it manually when you run the application.\n\n## How To Install\nYou can download the binary for your specific platform on the release page and run the program on your terminal. Specific instructions below:\n\n### Linux\n- Download the zipfile:\n```bash\ncurl -O -L https://github.com/AvicennaJr/ShellMate/releases/download/v1.0.0/shellmate_linux_amd64_v1.0.0.tar.gz\n```\n- Extract contents of the zip file and place it on the `/usr/local/bin` directory\n```\nsudo tar -C /usr/local/bin -xzvf shellmate_linux_amd64_v1.0.0.tar.gz\n```\n- Start the program with: `shellmate`\n\n### Windows\n- Download the zip file from the [releases page](https://github.com/AvicennaJr/ShellMate/releases/download/v1.0.0/shellmate_windows_amd64_v1.0.0.tar.gz)\n- Extract the binary file and run the program with:\n```powershell\nshellmate.exe\n```\n- You could optionally add the executable to path. See detailed instructions [here](https://medium.com/@kevinmarkvi/how-to-add-executables-to-your-path-in-windows-5ffa4ce61a53)\n\n### Mac OS \nDue to Apple's strict policy, you'll have to build the binary file from sources. See instructions on the next section.\n\n### Building From Sources \n- Make sure you have [go installed](https://go.dev/doc/install)\n- Clone the repository with:\n```bash\ngit clone github.com/AvicennaJr/ShellMate\n```\n- Enter the directory:\n```bash\ncd ShellMate\n```\n- Build the program with:\n```\ngo build -o shellmate\n```\n- Run the created binary with: `shellmate`\n\n## Issues and Contributions\nFor any problems or suggestions open an issue. If you want to contribute, create a pull request.\n\n## Author\nAnother tool brought to you by [Avicenna](https://github.com/AvicennaJr/ShellMate)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favicennajr%2Fshellmate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Favicennajr%2Fshellmate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Favicennajr%2Fshellmate/lists"}