| Name | nuralshell JSON |
| Version |
0.1.4
JSON |
| download |
| home_page | None |
| Summary | A powerful CLI agent for system automation and file management. |
| upload_time | 2025-10-18 22:39:30 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | MIT |
| keywords |
ai
cli
agent
shell
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# NuralShell: Your AI-Powered Terminal Assistant
NuralShell is an intelligent AI assistant designed to streamline your terminal interactions, especially for server deployment and automation tasks. It operates with root permissions, allowing it to execute shell commands (with your explicit confirmation for safety), read and write files, and maintain a persistent chat history across sessions. NuralShell is flexible, supporting both OpenAI/ChatGPT and Google Gemini as its underlying AI model.
## Features
* **Intelligent Command Execution:** Safely execute shell commands with user confirmation.
* **File System Interaction:** Read and write files to manage code, configurations, and data.
* **Persistent Chat History:** Maintains conversation context across sessions for a seamless experience.
* **Configurable AI Model:** Easily switch between OpenAI/ChatGPT and Google Gemini, with simple API key and model name setup.
* **Modular Architecture:** Built with a clean, modular design using sub-agents for specific tasks like command execution and file I/O.
## Installation
You can install NuralShell as a Python package using `pip`.
```bash
pip install NuralShell
```
## Configuration
Upon its first run, NuralShell will guide you through a one-time setup process to configure your AI model (ChatGPT or Gemini), API key, and desired model name. This configuration is saved in `~/.NuralShell/config.json`.
You can also set your API keys as environment variables:
* For OpenAI/ChatGPT: `OPENAI_API_KEY`
* For Gemini: `GEMINI_API_KEY`
## Usage
Once installed, you can launch NuralShell directly from your terminal:
```bash
nuralshell
```
### Basic Interaction
NuralShell acts like a conversational terminal. You can ask it to perform tasks, run commands, or read/write files.
```
You: List all files in the current directory.
NuralShell: Do you want to Execute `dir`? (Y/N)
You: Y
NuralShell: (output of `dir` command)
```
### Example Commands
* **Read a file:**
```
You: Read the content of `my_script.py`
```
* **Write to a file:**
```
You: Write "Hello, World!" to `output.txt`
```
* **Execute a shell command:**
```
You: Update the system packages.
NuralShell: Do you want to Execute `sudo apt update && sudo apt upgrade -y`? (Y/N)
You: Y
```
### Exiting NuralShell
To exit the NuralShell session, simply type `exit` or `quit`:
```
You: exit
```
Raw data
{
"_id": null,
"home_page": null,
"name": "nuralshell",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "ai, cli, agent, shell",
"author": null,
"author_email": "Sheikh Mujtaba <smujtabaja@email.com>",
"download_url": "https://files.pythonhosted.org/packages/05/11/6df130f79fbda34f0f981d27fc878f336cf134f988ee92f2befbd4769770/nuralshell-0.1.4.tar.gz",
"platform": null,
"description": "# NuralShell: Your AI-Powered Terminal Assistant\r\n\r\nNuralShell is an intelligent AI assistant designed to streamline your terminal interactions, especially for server deployment and automation tasks. It operates with root permissions, allowing it to execute shell commands (with your explicit confirmation for safety), read and write files, and maintain a persistent chat history across sessions. NuralShell is flexible, supporting both OpenAI/ChatGPT and Google Gemini as its underlying AI model.\r\n\r\n## Features\r\n\r\n* **Intelligent Command Execution:** Safely execute shell commands with user confirmation.\r\n* **File System Interaction:** Read and write files to manage code, configurations, and data.\r\n* **Persistent Chat History:** Maintains conversation context across sessions for a seamless experience.\r\n* **Configurable AI Model:** Easily switch between OpenAI/ChatGPT and Google Gemini, with simple API key and model name setup.\r\n* **Modular Architecture:** Built with a clean, modular design using sub-agents for specific tasks like command execution and file I/O.\r\n\r\n## Installation\r\n\r\nYou can install NuralShell as a Python package using `pip`.\r\n\r\n```bash\r\npip install NuralShell\r\n```\r\n\r\n## Configuration\r\n\r\nUpon its first run, NuralShell will guide you through a one-time setup process to configure your AI model (ChatGPT or Gemini), API key, and desired model name. This configuration is saved in `~/.NuralShell/config.json`.\r\n\r\nYou can also set your API keys as environment variables:\r\n* For OpenAI/ChatGPT: `OPENAI_API_KEY`\r\n* For Gemini: `GEMINI_API_KEY`\r\n\r\n## Usage\r\n\r\nOnce installed, you can launch NuralShell directly from your terminal:\r\n\r\n```bash\r\nnuralshell\r\n```\r\n\r\n### Basic Interaction\r\n\r\nNuralShell acts like a conversational terminal. You can ask it to perform tasks, run commands, or read/write files.\r\n\r\n```\r\nYou: List all files in the current directory.\r\nNuralShell: Do you want to Execute `dir`? (Y/N)\r\nYou: Y\r\nNuralShell: (output of `dir` command)\r\n```\r\n\r\n### Example Commands\r\n\r\n* **Read a file:**\r\n ```\r\n You: Read the content of `my_script.py`\r\n ```\r\n* **Write to a file:**\r\n ```\r\n You: Write \"Hello, World!\" to `output.txt`\r\n ```\r\n* **Execute a shell command:**\r\n ```\r\n You: Update the system packages.\r\n NuralShell: Do you want to Execute `sudo apt update && sudo apt upgrade -y`? (Y/N)\r\n You: Y\r\n ```\r\n\r\n### Exiting NuralShell\r\n\r\nTo exit the NuralShell session, simply type `exit` or `quit`:\r\n\r\n```\r\nYou: exit\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A powerful CLI agent for system automation and file management.",
"version": "0.1.4",
"project_urls": {
"Homepage": "https://github.com/Sheikh-Muhammad-Mujtaba/nuralshell"
},
"split_keywords": [
"ai",
" cli",
" agent",
" shell"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "221b62553012926c10b22c7fa61bc513b5339d0b3108b66f7c80b64dbd7511c9",
"md5": "bb765b84846169b8e1824b2816766074",
"sha256": "6873077022ba1df55840f708f199a19c64505e28515039185617196dd2e48b2b"
},
"downloads": -1,
"filename": "nuralshell-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bb765b84846169b8e1824b2816766074",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 7446,
"upload_time": "2025-10-18T22:39:29",
"upload_time_iso_8601": "2025-10-18T22:39:29.666402Z",
"url": "https://files.pythonhosted.org/packages/22/1b/62553012926c10b22c7fa61bc513b5339d0b3108b66f7c80b64dbd7511c9/nuralshell-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "05116df130f79fbda34f0f981d27fc878f336cf134f988ee92f2befbd4769770",
"md5": "a48d6845e8be392b33275aa6af223378",
"sha256": "cf3e844c521c059ee884fb6e1777473acc38f10834f07a42ce62be6c718ae1a3"
},
"downloads": -1,
"filename": "nuralshell-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "a48d6845e8be392b33275aa6af223378",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 6778,
"upload_time": "2025-10-18T22:39:30",
"upload_time_iso_8601": "2025-10-18T22:39:30.861117Z",
"url": "https://files.pythonhosted.org/packages/05/11/6df130f79fbda34f0f981d27fc878f336cf134f988ee92f2befbd4769770/nuralshell-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-18 22:39:30",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Sheikh-Muhammad-Mujtaba",
"github_project": "nuralshell",
"github_not_found": true,
"lcname": "nuralshell"
}
