{"id":16393558,"url":"https://github.com/code-yeongyu/aishell","last_synced_at":"2025-04-09T10:08:16.833Z","repository":{"id":65641750,"uuid":"595980893","full_name":"code-yeongyu/AiShell","owner":"code-yeongyu","description":"AiShell: A Natural Language Shell like GitHub Copilot X, Powered by ChatGPT","archived":false,"fork":false,"pushed_at":"2023-10-18T12:52:21.000Z","size":1634,"stargazers_count":154,"open_issues_count":2,"forks_count":14,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-02T08:12:44.616Z","etag":null,"topics":["aishell","artificial-intelligence","chatgpt","copilot","gpt3","openai","openai-api","python","revchatgpt","shell"],"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/code-yeongyu.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-02-01T07:59:13.000Z","updated_at":"2025-03-19T16:46:58.000Z","dependencies_parsed_at":"2023-02-22T02:46:10.546Z","dependency_job_id":"c766349e-a70e-4167-9c30-97234647d9f5","html_url":"https://github.com/code-yeongyu/AiShell","commit_stats":null,"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-yeongyu%2FAiShell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-yeongyu%2FAiShell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-yeongyu%2FAiShell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-yeongyu%2FAiShell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/code-yeongyu","download_url":"https://codeload.github.com/code-yeongyu/AiShell/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248018060,"owners_count":21034048,"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":["aishell","artificial-intelligence","chatgpt","copilot","gpt3","openai","openai-api","python","revchatgpt","shell"],"created_at":"2024-10-11T04:53:36.802Z","updated_at":"2025-04-09T10:08:16.810Z","avatar_url":"https://github.com/code-yeongyu.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AiShell 🤖\n\n[![codecov](https://codecov.io/gh/code-yeongyu/AiShell/branch/master/graph/badge.svg?token=MR72XGUQWJ)](https://codecov.io/gh/code-yeongyu/AiShell)\n[![Release Package to PyPI](https://github.com/code-yeongyu/AiShell/actions/workflows/release.yml/badge.svg)](https://github.com/code-yeongyu/AiShell/actions/workflows/release.yml)\n[![PyPI version](https://badge.fury.io/py/aishell.svg)](https://badge.fury.io/py/aishell)\n[![Downloads](https://static.pepy.tech/badge/aishell)](https://pepy.tech/project/aishell)\n\nA simple Python code that connects to OpenAI's ChatGPT and executes the returned results.\n\nIf you are interested in these projects, please checkout AiShell's brother project: [YGK-a](https://github.com/code-yeongyu/YGK-a). YGK-a is a client for the ChatGPT from your terminal, and also supports unix/linux pipelines.\n\n## Demo\n\n![Demo](https://raw.githubusercontent.com/code-yeongyu/AiShell/master/images/example.gif)\n\n## Key Features 💡\n\n- Interact with your computer using natural language\n- Automatically executes the command from the response of ChatGPT\n- Good for complex tasks like handling Git and extracting tar files\n- No need to search StackOverflow for commands, `AiShell` has got you covered\n- `AiShell` simplifies the process of setting up and retrieving tokens or API keys.\n  - With `AiShell`, you don't have to worry about the technical details.\n  - Simply install `AiShell`, execute it, and you're ready to go!\n\n## Prerequisites 📚\n\n- Python 3.9+\n- ChatGPT Account (or OpenAI Account)\n\n## Getting Started 🚀\n\nTo begin using `AiShell`, start by installing it with pip:\n\n```sh\npip install aishell\n```\n\nOr you can use pipx:\n```sh\npipx install aishell\n```\n\nOnce you've installed `AiShell`, you can start using it right away.\nFor example, to print \"Hello World\" using `AiShell`, enter the following command:\n\n```sh\naishell 'print Hello World'\n```\n\n## Advanced Settings 🛠\n\nBy default, `AiShell` is configured to use the reverse-engineered ChatGPT client and retrieve login information from your browser, so you don't need to configure anything to use `AiShell`. However, for those who want to use different models with an OpenAI API Key, you can configure it as follows:\n\n1. Create an account on OpenAI.\n1. Go to \u003chttps://platform.openai.com/account/api-keys\u003e and copy your API key.\n1. Modify or create the `~/.ygka_openai_config.json` file as follows:\n\n  ```json\n  {\n      ...\n      \"language_model\": \"official_chatgpt\",\n      \"openai_api_key\": \"\u003cyour OpenAI API key\u003e\"\n  }\n  ```\n\nHere, you can add your OpenAI API key. This will enable AiShell to use the official chatgpt api and the API key when executing commands.\n\n## Contributions 💬\n\nFeel free to contribute to `AiShell` by adding more functionality or fixing bugs.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-yeongyu%2Faishell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcode-yeongyu%2Faishell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-yeongyu%2Faishell/lists"}