# `iwanna`
`iwanna` is a simple command line tool that leverages the power of OpenAI's GPT-4 model to help you find the right shell command to perform a specific action. With `iwanna`, you can get suggestions for shell commands to achieve your desired tasks, making your life easier and more efficient.
### Features
* 🪄 Get shell command suggestions based on your input
* 🤖 Utilizes OpenAI's GPT-4 model for accurate and relevant suggestions
* ✨ Easy to use and configure
### Demo of `iwanna` output
<sup>DISCLAIMER: Note that the suggestions from `iwanna` may not always be accurate or safe to run – use the suggested commands with great care.</sup>
---
## Installation
`iwanna` is preferably installed with `pipx`:
```bash
pipx install iwanna
```
However, you can also install it with `pip`:
```bash
pip install iwanna
```
## Configuration
Before using `iwanna`, you need to configure it with your OpenAI API key. This key allows the tool to access the OpenAI API and fetch suggestions from the GPT-4 model. To configure your API key, run:
```bash
iwanna --config
```
## Usage
To use `iwanna`, simply run the following command:
```bash
iwanna [options] <action>
```
Replace `<action>` with the task you want to perform.
### Example actions
```bash
iwanna search for a process
iwanna reduce the file size of a raw video file
iwanna find what wifi i am connected to
```
## License
This project is licensed under the MIT License. See the LICENSE file for details.
## Disclaimer
Note that the suggestions from `iwanna` may not be accurate or safe to run at all. Use the suggested output with great care.
This project is not affiliated with, nor endorsed by, OpenAI. It is an independent project created to showcase the potential use cases of the GPT-4 model.
Raw data
{
"_id": null,
"home_page": "https://github.com/kalaspuff/iwanna",
"name": "iwanna",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "cli tool,shell suggestion,gpt-4,openai shell assistant,ai assistant",
"author": "Carl Oscar Aaro",
"author_email": "hello@carloscar.com",
"download_url": "https://files.pythonhosted.org/packages/34/c8/fb1c22075a675b03d3cf91623225a5af9af20fc980cab2a6f09cac25de91/iwanna-0.0.2.tar.gz",
"platform": null,
"description": "# `iwanna`\n\n`iwanna` is a simple command line tool that leverages the power of OpenAI's GPT-4 model to help you find the right shell command to perform a specific action. With `iwanna`, you can get suggestions for shell commands to achieve your desired tasks, making your life easier and more efficient.\n\n### Features\n\n* \ud83e\ude84 Get shell command suggestions based on your input\n* \ud83e\udd16 Utilizes OpenAI's GPT-4 model for accurate and relevant suggestions\n* \u2728 Easy to use and configure\n\n### Demo of `iwanna` output\n\n\n\n<sup>DISCLAIMER: Note that the suggestions from `iwanna` may not always be accurate or safe to run \u2013 use the suggested commands with great care.</sup>\n\n---\n\n## Installation\n\n`iwanna` is preferably installed with `pipx`:\n\n```bash\npipx install iwanna\n```\n\nHowever, you can also install it with `pip`:\n\n```bash\npip install iwanna\n```\n\n## Configuration\n\nBefore using `iwanna`, you need to configure it with your OpenAI API key. This key allows the tool to access the OpenAI API and fetch suggestions from the GPT-4 model. To configure your API key, run:\n\n```bash\niwanna --config\n```\n\n## Usage\n\nTo use `iwanna`, simply run the following command:\n\n```bash\niwanna [options] <action>\n```\n\nReplace `<action>` with the task you want to perform.\n\n### Example actions\n\n```bash\niwanna search for a process\niwanna reduce the file size of a raw video file\niwanna find what wifi i am connected to\n```\n\n## License\n\nThis project is licensed under the MIT License. See the LICENSE file for details.\n\n## Disclaimer\n\nNote that the suggestions from `iwanna` may not be accurate or safe to run at all. Use the suggested output with great care.\n\nThis project is not affiliated with, nor endorsed by, OpenAI. It is an independent project created to showcase the potential use cases of the GPT-4 model.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CLI tool to get shell command suggestions using GPT-4 to help you perform your action.",
"version": "0.0.2",
"split_keywords": [
"cli tool",
"shell suggestion",
"gpt-4",
"openai shell assistant",
"ai assistant"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "59d79084c404cedbd8cf3fcab7661183543b796ad7e7397e0504adc77a78ff10",
"md5": "1e9fd69f558cc2a95d8bebe9e2ce8f82",
"sha256": "9c53f6ba4b83a9b02e9dd737399d712661938e686a5ee8425a6fbc6a93cf7b1e"
},
"downloads": -1,
"filename": "iwanna-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1e9fd69f558cc2a95d8bebe9e2ce8f82",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 9973,
"upload_time": "2023-03-21T15:37:53",
"upload_time_iso_8601": "2023-03-21T15:37:53.167163Z",
"url": "https://files.pythonhosted.org/packages/59/d7/9084c404cedbd8cf3fcab7661183543b796ad7e7397e0504adc77a78ff10/iwanna-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "34c8fb1c22075a675b03d3cf91623225a5af9af20fc980cab2a6f09cac25de91",
"md5": "54fe4ab4f219fbaafe5d1572bd96cd74",
"sha256": "85b00626eb2a8e66e2ecca384e1d1e86e2d08592682ef1742d6c188f259d5a80"
},
"downloads": -1,
"filename": "iwanna-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "54fe4ab4f219fbaafe5d1572bd96cd74",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 9619,
"upload_time": "2023-03-21T15:37:54",
"upload_time_iso_8601": "2023-03-21T15:37:54.286845Z",
"url": "https://files.pythonhosted.org/packages/34/c8/fb1c22075a675b03d3cf91623225a5af9af20fc980cab2a6f09cac25de91/iwanna-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-21 15:37:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "kalaspuff",
"github_project": "iwanna",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "iwanna"
}
JSON
