AiShell: Your Command Line Companion π€
Developed with simplicity and efficiency in mind, AiShell is a straightforward Python tool that connects to OpenAI's ChatGPT to execute commands returned by the AI. This project aims to streamline interactions between users and their computers by utilizing natural language processing capabilities.
Overview
AiShell serves as a bridge between human instructions and computer execution. With a focus on minimizing the technical know-how required to perform complex tasks, AiShell interprets user input via ChatGPT and directly executes the corresponding commands. This makes it particularly advantageous for intricate command line operations such as managing Git repositories or decompressing tar files.
Key Features π‘
- Natural Language Interaction: Speaks your language, literally. Commands are given in plain English, enhancing user-friendliness.
- Automatic Execution: Responses are not just conversational; they result in real action from your command line.
- Complex Task Handling: Facilitates the execution of sophisticated command-line tasks effortlessly.
- No More StackOverflow: Reduces the need for searching online forums for command-line solutions.
- Simplified Setup: AiShell takes care of the intricate details involved in setting up tokens or API keys, allowing users to jump straight into usage.
Prerequisites π
Before getting started with AiShell, ensure you have:
- Python version 3.9 or higher
- An account with ChatGPT or OpenAI
Getting Started π
Kick-starting your journey with AiShell is easy:
-
Install AiShell using the following command:
pip install aishell
Alternatively, you can use pipx:
pipx install aishell
-
With AiShell ready to go, an example usage might be printing "Hello World" with a simple command:
aishell 'print Hello World'
Advanced Settings π
AiShell is designed to be plug-and-play, using a reverse-engineered ChatGPT client to auto-fetch login details from your web browser. However, users with preferences for specific models via an OpenAI API Key can customize settings:
- Create an OpenAI account.
- Navigate to your OpenAI account's API Keys section (https://platform.openai.com/account/api-keys) and copy your API key.
- Modify or create the
~/.ygka_openai_config.json
file with the following structure:{ ... "language_model": "official_chatgpt", "openai_api_key": "<your OpenAI API key>" }
This configuration allows AiShell to interact with the official ChatGPT API using your provided API key.
Contributions π¬
AiShell embraces community contributions. Developers and enthusiasts are encouraged to enhance its capabilities or fix existing issues. Whether you wish to expand its functionality or improve its reliability, your input is valued.
AiShell isn't just another tool β it's your partner in simplifying command-line tasks with the power of AI.