| Name | sheller-ai JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | None |
| Summary | AI-Powered Terminal Command Assistant - Natural Language to Commands |
| upload_time | 2025-09-08 13:48:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
terminal
cli
ai
commands
shell
productivity
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 🚀 Sheller - AI-Powered Terminal Command Assistant
> **Transform natural language into executable commands with style!**
[](https://www.python.org/downloads/)
[](https://opensource.org/licenses/MIT)
[](https://www.microsoft.com/windows)
[](https://www.apple.com/macos/)
[](https://www.linux.org/)
## ✨ Features
- 🧠 **Natural Language Processing**: Type requests in plain English
- ⚡ **Smart Command Translation**: Automatic Unix-to-Windows command conversion
- 🎨 **Retro Terminal UI**: Beautiful, nostalgic interface with colors and ASCII art
- ⌨️ **Keyboard Shortcuts**: Ctrl+K for processing, arrow keys for history
- 🔄 **PowerShell Fallback**: Intelligent fallback from CMD to PowerShell
- 📱 **Cross-Platform**: Works on Windows, macOS, and Linux
- 🚀 **Real-time Execution**: See commands execute with live output
- 📚 **Command History**: Navigate through your command history
## 🎯 Use Cases
- **System Administrators**: Quick system diagnostics and management
- **Developers**: Rapid command execution without remembering syntax
- **Power Users**: Streamlined terminal workflow
- **Beginners**: Learn commands through natural language
- **DevOps Engineers**: Efficient system operations
## 🚀 Quick Start
### Prerequisites
Before using Sheller, you need to set up your **Google Gemini API Key**:
#### 1. Get Your Gemini API Key
1. Visit [Google AI Studio](https://makersuite.google.com/app/apikey)
2. Sign in with your Google account
3. Click **"Create API Key"**
4. Copy the generated API key
#### 2. Set Environment Variable
**Windows (PowerShell):**
```powershell
# Temporary (current session only)
$env:GEMINI_API_KEY="your_api_key_here"
# Permanent (add to user profile)
[Environment]::SetEnvironmentVariable("GEMINI_API_KEY", "your_api_key_here", "User")
```
**Windows (Command Prompt):**
```cmd
# Temporary (current session only)
set GEMINI_API_KEY=your_api_key_here
# Permanent (add to user profile)
setx GEMINI_API_KEY "your_api_key_here"
```
**macOS/Linux:**
```bash
# Temporary (current session only)
export GEMINI_API_KEY="your_api_key_here"
# Permanent (add to ~/.bashrc or ~/.zshrc)
echo 'export GEMINI_API_KEY="your_api_key_here"' >> ~/.bashrc
source ~/.bashrc
```
#### 3. Alternative: Create .env File
Create a `.env` file in your project directory:
```bash
# .env file
GEMINI_API_KEY=your_api_key_here
```
### Installation
#### Option 1: Python Package (Recommended for Developers)
```bash
pip install sheller
```
#### Option 2: Windows Installer (Recommended for End Users)
Download the latest `.exe` installer from our [releases page](https://github.com/sheller/sheller/releases).
### Usage
#### Launch the Application
```bash
sheller
```
#### Natural Language Commands
```
Type: "show me all files in this directory"
Press: Ctrl+K
Result: dir /a
Press: Enter to execute
```
#### Direct Commands
```
Type: dir
Press: Enter
Result: Executes immediately
```
## ⌨️ Keyboard Shortcuts
| Shortcut | Action |
|----------|---------|
| `Ctrl+K` | Process natural language input |
| `Enter` | Execute command |
| `↑/↓` | Navigate command history |
| `Ctrl+C` | Exit application |
| `Backspace` | Edit current input |
| `Delete` | Remove characters |
## 🔧 Supported Commands
### File Operations
- **List files**: `ls` → `dir`
- **List hidden files**: `ls -a` → `dir /a`
- **View file**: `cat` → `type`
- **Copy file**: `cp` → `copy`
- **Move file**: `mv` → `move`
- **Delete file**: `rm` → `del`
### System Information
- **Process list**: `ps aux` → `tasklist`
- **System info**: `systeminfo`
- **Network config**: `ifconfig` → `ipconfig`
- **Disk space**: `df` → PowerShell equivalent
- **Memory usage**: `wmic` commands
### Network Tools
- **Ping**: `ping`
- **Traceroute**: `traceroute` → `tracert`
- **DNS lookup**: `nslookup`
- **Network connections**: `netstat`
## 🏗️ Architecture
```
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
│ Natural │ │ Command │ │ Execution │
│ Language │───▶│ Translation │───▶│ Engine │
│ Input │ │ Engine │ │ │
└─────────────────┘ └──────────────────┘ └─────────────────┘
│ │ │
▼ ▼ ▼
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
│ Retro UI │ │ Shell │ │ Output │
│ Interface │ │ Detection │ │ Display │
└─────────────────┘ └──────────────────┘ └─────────────────┘
```
## 🛠️ Development
### Prerequisites
- Python 3.8+
- pip
- setuptools
### Setup Development Environment
```bash
# Clone the repository
git clone https://github.com/sheller/sheller.git
cd sheller
# Install development dependencies
pip install -e .
# Run the application
python src/sheller/main.py
```
### Building the Package
```bash
# Build source distribution
python -m build --sdist
# Build wheel
python -m build --wheel
# Install locally
pip install dist/sheller-1.0.0-py3-none-any.whl
```
## 📦 Distribution
### Python Package
- **PyPI**: `pip install sheller`
- **Source**: GitHub releases
- **Wheel**: Pre-built for multiple Python versions
### Windows Installer
- **Inno Setup**: Professional installer with custom branding
- **Auto-updates**: Built-in update mechanism
- **Desktop shortcuts**: Easy access for end users
## 🤝 Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
### Development Areas
- [ ] Enhanced AI command suggestions
- [ ] Plugin system for custom commands
- [ ] Configuration file support
- [ ] Theme customization
- [ ] Command templates
- [ ] Integration with popular shells
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🙏 Acknowledgments
- **ASCII Art**: Inspired by retro terminal aesthetics
- **Command Translation**: Based on Unix-to-Windows mappings
- **UI Design**: Firebase terminal inspiration
- **Community**: All contributors and users
## 📞 Support
- **Documentation**: [docs.sheller.com](https://docs.sheller.com)
- **Issues**: [GitHub Issues](https://github.com/sheller/sheller/issues)
- **Discussions**: [GitHub Discussions](https://github.com/sheller/sheller/discussions)
- **Email**: team@sheller.com
## 🚀 Roadmap
### v1.1.0 (Q2 2024)
- [ ] AI-powered command suggestions
- [ ] Plugin architecture
- [ ] Configuration management
### v1.2.0 (Q3 2024)
- [ ] Cloud sync for settings
- [ ] Command templates
- [ ] Advanced theming
### v2.0.0 (Q4 2024)
- [ ] Machine learning integration
- [ ] Cross-device sync
- [ ] Enterprise features
---
**Made with ❤️ by the Sheller Team**
*Transform your terminal experience today!*
Raw data
{
"_id": null,
"home_page": null,
"name": "sheller-ai",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "terminal, cli, ai, commands, shell, productivity",
"author": null,
"author_email": "Sheller Team <team@sheller.com>",
"download_url": "https://files.pythonhosted.org/packages/29/b2/c37f887aa542a0cf13b0c1f3914dd34846f0e518dd45fa481d7b2175794e/sheller_ai-1.0.0.tar.gz",
"platform": null,
"description": "# \ud83d\ude80 Sheller - AI-Powered Terminal Command Assistant\r\n\r\n> **Transform natural language into executable commands with style!**\r\n\r\n[](https://www.python.org/downloads/)\r\n[](https://opensource.org/licenses/MIT)\r\n[](https://www.microsoft.com/windows)\r\n[](https://www.apple.com/macos/)\r\n[](https://www.linux.org/)\r\n\r\n## \u2728 Features\r\n\r\n- \ud83e\udde0 **Natural Language Processing**: Type requests in plain English\r\n- \u26a1 **Smart Command Translation**: Automatic Unix-to-Windows command conversion\r\n- \ud83c\udfa8 **Retro Terminal UI**: Beautiful, nostalgic interface with colors and ASCII art\r\n- \u2328\ufe0f **Keyboard Shortcuts**: Ctrl+K for processing, arrow keys for history\r\n- \ud83d\udd04 **PowerShell Fallback**: Intelligent fallback from CMD to PowerShell\r\n- \ud83d\udcf1 **Cross-Platform**: Works on Windows, macOS, and Linux\r\n- \ud83d\ude80 **Real-time Execution**: See commands execute with live output\r\n- \ud83d\udcda **Command History**: Navigate through your command history\r\n\r\n## \ud83c\udfaf Use Cases\r\n\r\n- **System Administrators**: Quick system diagnostics and management\r\n- **Developers**: Rapid command execution without remembering syntax\r\n- **Power Users**: Streamlined terminal workflow\r\n- **Beginners**: Learn commands through natural language\r\n- **DevOps Engineers**: Efficient system operations\r\n\r\n## \ud83d\ude80 Quick Start\r\n\r\n### Prerequisites\r\n\r\nBefore using Sheller, you need to set up your **Google Gemini API Key**:\r\n\r\n#### 1. Get Your Gemini API Key\r\n1. Visit [Google AI Studio](https://makersuite.google.com/app/apikey)\r\n2. Sign in with your Google account\r\n3. Click **\"Create API Key\"**\r\n4. Copy the generated API key\r\n\r\n#### 2. Set Environment Variable\r\n\r\n**Windows (PowerShell):**\r\n```powershell\r\n# Temporary (current session only)\r\n$env:GEMINI_API_KEY=\"your_api_key_here\"\r\n\r\n# Permanent (add to user profile)\r\n[Environment]::SetEnvironmentVariable(\"GEMINI_API_KEY\", \"your_api_key_here\", \"User\")\r\n```\r\n\r\n**Windows (Command Prompt):**\r\n```cmd\r\n# Temporary (current session only)\r\nset GEMINI_API_KEY=your_api_key_here\r\n\r\n# Permanent (add to user profile)\r\nsetx GEMINI_API_KEY \"your_api_key_here\"\r\n```\r\n\r\n**macOS/Linux:**\r\n```bash\r\n# Temporary (current session only)\r\nexport GEMINI_API_KEY=\"your_api_key_here\"\r\n\r\n# Permanent (add to ~/.bashrc or ~/.zshrc)\r\necho 'export GEMINI_API_KEY=\"your_api_key_here\"' >> ~/.bashrc\r\nsource ~/.bashrc\r\n```\r\n\r\n#### 3. Alternative: Create .env File\r\nCreate a `.env` file in your project directory:\r\n```bash\r\n# .env file\r\nGEMINI_API_KEY=your_api_key_here\r\n```\r\n\r\n### Installation\r\n\r\n#### Option 1: Python Package (Recommended for Developers)\r\n```bash\r\npip install sheller\r\n```\r\n\r\n#### Option 2: Windows Installer (Recommended for End Users)\r\nDownload the latest `.exe` installer from our [releases page](https://github.com/sheller/sheller/releases).\r\n\r\n### Usage\r\n\r\n#### Launch the Application\r\n```bash\r\nsheller\r\n```\r\n\r\n#### Natural Language Commands\r\n```\r\nType: \"show me all files in this directory\"\r\nPress: Ctrl+K\r\nResult: dir /a\r\nPress: Enter to execute\r\n```\r\n\r\n#### Direct Commands\r\n```\r\nType: dir\r\nPress: Enter\r\nResult: Executes immediately\r\n```\r\n\r\n## \u2328\ufe0f Keyboard Shortcuts\r\n\r\n| Shortcut | Action |\r\n|----------|---------|\r\n| `Ctrl+K` | Process natural language input |\r\n| `Enter` | Execute command |\r\n| `\u2191/\u2193` | Navigate command history |\r\n| `Ctrl+C` | Exit application |\r\n| `Backspace` | Edit current input |\r\n| `Delete` | Remove characters |\r\n\r\n## \ud83d\udd27 Supported Commands\r\n\r\n### File Operations\r\n- **List files**: `ls` \u2192 `dir`\r\n- **List hidden files**: `ls -a` \u2192 `dir /a`\r\n- **View file**: `cat` \u2192 `type`\r\n- **Copy file**: `cp` \u2192 `copy`\r\n- **Move file**: `mv` \u2192 `move`\r\n- **Delete file**: `rm` \u2192 `del`\r\n\r\n### System Information\r\n- **Process list**: `ps aux` \u2192 `tasklist`\r\n- **System info**: `systeminfo`\r\n- **Network config**: `ifconfig` \u2192 `ipconfig`\r\n- **Disk space**: `df` \u2192 PowerShell equivalent\r\n- **Memory usage**: `wmic` commands\r\n\r\n### Network Tools\r\n- **Ping**: `ping`\r\n- **Traceroute**: `traceroute` \u2192 `tracert`\r\n- **DNS lookup**: `nslookup`\r\n- **Network connections**: `netstat`\r\n\r\n## \ud83c\udfd7\ufe0f Architecture\r\n\r\n```\r\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\r\n\u2502 Natural \u2502 \u2502 Command \u2502 \u2502 Execution \u2502\r\n\u2502 Language \u2502\u2500\u2500\u2500\u25b6\u2502 Translation \u2502\u2500\u2500\u2500\u25b6\u2502 Engine \u2502\r\n\u2502 Input \u2502 \u2502 Engine \u2502 \u2502 \u2502\r\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\r\n \u2502 \u2502 \u2502\r\n \u25bc \u25bc \u25bc\r\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\r\n\u2502 Retro UI \u2502 \u2502 Shell \u2502 \u2502 Output \u2502\r\n\u2502 Interface \u2502 \u2502 Detection \u2502 \u2502 Display \u2502\r\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\r\n```\r\n\r\n## \ud83d\udee0\ufe0f Development\r\n\r\n### Prerequisites\r\n- Python 3.8+\r\n- pip\r\n- setuptools\r\n\r\n### Setup Development Environment\r\n```bash\r\n# Clone the repository\r\ngit clone https://github.com/sheller/sheller.git\r\ncd sheller\r\n\r\n# Install development dependencies\r\npip install -e .\r\n\r\n# Run the application\r\npython src/sheller/main.py\r\n```\r\n\r\n### Building the Package\r\n```bash\r\n# Build source distribution\r\npython -m build --sdist\r\n\r\n# Build wheel\r\npython -m build --wheel\r\n\r\n# Install locally\r\npip install dist/sheller-1.0.0-py3-none-any.whl\r\n```\r\n\r\n## \ud83d\udce6 Distribution\r\n\r\n### Python Package\r\n- **PyPI**: `pip install sheller`\r\n- **Source**: GitHub releases\r\n- **Wheel**: Pre-built for multiple Python versions\r\n\r\n### Windows Installer\r\n- **Inno Setup**: Professional installer with custom branding\r\n- **Auto-updates**: Built-in update mechanism\r\n- **Desktop shortcuts**: Easy access for end users\r\n\r\n## \ud83e\udd1d Contributing\r\n\r\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.\r\n\r\n### Development Areas\r\n- [ ] Enhanced AI command suggestions\r\n- [ ] Plugin system for custom commands\r\n- [ ] Configuration file support\r\n- [ ] Theme customization\r\n- [ ] Command templates\r\n- [ ] Integration with popular shells\r\n\r\n## \ud83d\udcc4 License\r\n\r\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\r\n\r\n## \ud83d\ude4f Acknowledgments\r\n\r\n- **ASCII Art**: Inspired by retro terminal aesthetics\r\n- **Command Translation**: Based on Unix-to-Windows mappings\r\n- **UI Design**: Firebase terminal inspiration\r\n- **Community**: All contributors and users\r\n\r\n## \ud83d\udcde Support\r\n\r\n- **Documentation**: [docs.sheller.com](https://docs.sheller.com)\r\n- **Issues**: [GitHub Issues](https://github.com/sheller/sheller/issues)\r\n- **Discussions**: [GitHub Discussions](https://github.com/sheller/sheller/discussions)\r\n- **Email**: team@sheller.com\r\n\r\n## \ud83d\ude80 Roadmap\r\n\r\n### v1.1.0 (Q2 2024)\r\n- [ ] AI-powered command suggestions\r\n- [ ] Plugin architecture\r\n- [ ] Configuration management\r\n\r\n### v1.2.0 (Q3 2024)\r\n- [ ] Cloud sync for settings\r\n- [ ] Command templates\r\n- [ ] Advanced theming\r\n\r\n### v2.0.0 (Q4 2024)\r\n- [ ] Machine learning integration\r\n- [ ] Cross-device sync\r\n- [ ] Enterprise features\r\n\r\n---\r\n\r\n**Made with \u2764\ufe0f by the Sheller Team**\r\n\r\n*Transform your terminal experience today!*\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "AI-Powered Terminal Command Assistant - Natural Language to Commands",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://docs.sheller.com",
"Homepage": "https://sheller.com",
"Issues": "https://github.com/sheller/sheller/issues",
"Repository": "https://github.com/sheller/sheller"
},
"split_keywords": [
"terminal",
" cli",
" ai",
" commands",
" shell",
" productivity"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2c9b1a1c3bec8cf1a60d1362697b06052408f36500bc678aa13321b69caadb56",
"md5": "a2f332d075f27c4c029454281b82eb9c",
"sha256": "9b91d52dedbd4a5c365861bac8604539abd12e96d9a169c96560553962e0ca45"
},
"downloads": -1,
"filename": "sheller_ai-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a2f332d075f27c4c029454281b82eb9c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 11010,
"upload_time": "2025-09-08T13:48:26",
"upload_time_iso_8601": "2025-09-08T13:48:26.140675Z",
"url": "https://files.pythonhosted.org/packages/2c/9b/1a1c3bec8cf1a60d1362697b06052408f36500bc678aa13321b69caadb56/sheller_ai-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "29b2c37f887aa542a0cf13b0c1f3914dd34846f0e518dd45fa481d7b2175794e",
"md5": "9fd37b1ec69ec4b2914072041de5c338",
"sha256": "3bdcf6e02ab0077cc853cd8712406401d495df7be0e86a322c39cf713c4159e7"
},
"downloads": -1,
"filename": "sheller_ai-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "9fd37b1ec69ec4b2914072041de5c338",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 13443,
"upload_time": "2025-09-08T13:48:27",
"upload_time_iso_8601": "2025-09-08T13:48:27.434652Z",
"url": "https://files.pythonhosted.org/packages/29/b2/c37f887aa542a0cf13b0c1f3914dd34846f0e518dd45fa481d7b2175794e/sheller_ai-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-08 13:48:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sheller",
"github_project": "sheller",
"github_not_found": true,
"lcname": "sheller-ai"
}
