commandor-ai 0.0.1__tar.gz

commandor_ai-0.0.1/LICENSE

@@ -0,0 +1,92 @@
+# Commandor License
+
+## Open Source License with Commercial Attribution Requirements
+
+This software is **free and open source** for all users, with specific attribution requirements for commercial use.
+
+### Personal/Individual Use (Free)
+
+**Permission is hereby granted, free of charge, to any individual** to use, copy, modify, distribute, and contribute to this software for **personal, educational, or non-commercial purposes** without any restrictions or attribution requirements.
+
+### Commercial Use (Free with Attribution)
+
+**Commercial use is permitted free of charge**, provided that commercial users comply with the following attribution requirements:
+
+**Required Attribution:**
+- Display **"Powered by Commandor"** prominently in your product interface, documentation, or about section
+- Include a clickable link to the official repository: `https://github.com/ravin-d-27/Commandor`
+- Mention Commandor in relevant marketing materials, press releases, or product announcements
+- If feasible, submit a brief case study or testimonial about your usage for our community showcase
+
+**Commercial use includes:**
+- Use by organizations or businesses of any size
+- Integration into commercial products or services
+- Use that generates revenue or commercial benefit
+- Use by government agencies or institutions
+
+### Contributions Welcome
+
+**All contributions are welcome and encouraged:**
+- Pull requests, bug reports, and feature suggestions are appreciated
+- Contributors retain copyright to their contributions
+- By contributing, you agree your contributions will be licensed under the same terms
+- All contributors will be acknowledged in the project documentation
+
+### Reproduction and Redistribution
+
+**Permitted:**
+- ✅ Fork the repository and create derivatives
+- ✅ Modify and distribute modified versions
+- ✅ Use components in other projects
+- ✅ Create packages or distributions
+
+**Required for Reproduction/Redistribution:**
+- ❌ **You may NOT claim this software as your own original work**
+- ❌ **You may NOT remove or modify copyright notices**
+- ❌ **You may NOT redistribute without including this license**
+- ✅ **You MUST clearly indicate if changes were made**
+- ✅ **You MUST provide attribution to the original project**
+
+### Attribution Requirements for Derivatives
+
+If you create a derivative work or redistribute this software:
+- Include original copyright notice and this license
+- Clearly state that your work is based on Commandor
+- Provide link to the original repository
+- If you've made modifications, clearly indicate what was changed
+
+### Open Source Commitment
+
+This project is committed to remaining **free and open source forever**:
+- No future license changes that restrict existing freedoms
+- Community-driven development
+- Transparent decision making
+- Welcoming to all contributors regardless of background
+
+### Enforcement and Compliance
+
+- Attribution compliance is verified through community monitoring
+- Non-compliance will result in polite contact requesting correction
+- Repeated violations may result in license termination for that user
+- Community members are encouraged to report non-compliance
+
+### Definitions
+
+- **Personal Use**: Use by individuals for their own personal, educational, or research purposes
+- **Commercial Use**: Any use by organizations, businesses, or for commercial advantage
+- **Attribution**: Proper credit given to the original project and maintainers
+- **Derivative Work**: Software that incorporates, modifies, or builds upon this project
+
+### Disclaimer
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+**Copyright (c) 2025 Ravin D**
+
+**This software is proudly open source and free for everyone!**
+
+For questions about attribution requirements or to submit your case study, contact: [your-email@example.com]
+
+**⭐ If this project helps you, please star it on GitHub to help others discover it!**

commandor_ai-0.0.1/MANIFEST.in

@@ -0,0 +1,11 @@
+include README.md
+include LICENSE
+
+# Include all files inside the commandor package that aren't .py
+recursive-include commandor *
+
+# Exclude unnecessary files (optional but good practice)
+global-exclude *.pyc __pycache__ *.pyo *.pyd *.swp *.bak
+
+# Include any other data files, e.g., configs/templates if you have them
+# recursive-include commandor/templates *

commandor_ai-0.0.1/PKG-INFO

@@ -0,0 +1,216 @@
+Metadata-Version: 2.4
+Name: commandor-ai
+Version: 0.0.1
+Summary: An intelligent terminal assistant that uses AI to convert natural language to shell commands
+Home-page: https://github.com/ravin-d-27/Commandor
+Author: Ravin D
+Author-email: Ravin D <ravin.d3107@outlook.com>
+License: Proprietary
+Project-URL: Homepage, https://github.com/ravin-d-27/Commandor
+Project-URL: BugReports, https://github.com/ravin-d-27/Commandor/issues
+Project-URL: Source, https://github.com/ravin-d-27/Commandor
+Project-URL: Documentation, https://github.com/ravin-d-27/Commandor#readme
+Keywords: terminal,ai,shell,command-line,natural-language,gemini,assistant,automation,cli,productivity
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: Free for non-commercial use
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Shells
+Classifier: Topic :: System :: System Shells
+Classifier: Topic :: Terminals
+Classifier: Topic :: Utilities
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-generativeai>=0.3.0
+Requires-Dist: python-decouple>=3.6
+Requires-Dist: colorama>=0.4.4
+Requires-Dist: rich>=10.0.0
+Provides-Extra: windows
+Requires-Dist: pyreadline3>=3.4.1; extra == "windows"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# Commandor
+
+An intelligent terminal assistant that uses AI to **convert natural language into shell commands** and now **answers questions directly** with `/ask`.  
+Bring the power of AI to your terminal and work smarter!
+
+[![GitHub stars](https://img.shields.io/github/stars/ravin-d-27/Commandor?style=social)](https://github.com/ravin-d-27/Commandor/stargazers)
+[![License](https://img.shields.io/badge/License-Open%20Source%20with%20Attribution-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/Python-3.6%2B-blue.svg)](https://python.org)
+
+---
+
+
+## Key Features
+
+- **/ai** – Convert natural language instructions to shell commands
+- **/ask** – Ask AI anything: get explanations, coding help, system tips & more
+- **Beautiful interface** – Colorful ASCII art, emoji cues, color-coded prompts
+- **Context-aware** – Commands tailored to your current directory
+- **Safety checks** – Warn before running dangerous commands
+- **Command history** – Navigate with arrow keys (readline support)
+- **Cross-platform** – Works on Linux, macOS & Windows
+
+---
+
+## Installation
+
+### Clone & install (recommended)
+
+```bash
+git clone https://github.com/ravin-d-27/Commandor.git
+cd Commandor
+pip install -e .
+````
+
+### Set up your API key
+
+Get your Gemini API key from [Google AI Studio](https://makersuite.google.com/app/apikey):
+
+```bash
+echo "GEMINI=your_api_key_here" > ~/.env
+```
+
+Or set it directly:
+
+```bash
+export GEMINI=your_api_key_here
+```
+
+> **Windows tip:** Use `set GEMINI=your_api_key_here` instead
+
+---
+
+## Usage
+
+Run from any terminal:
+
+```bash
+commandor
+```
+
+---
+
+## 🛠️ Available Commands
+
+|             Command |                                              What it does |
+| ------------------: | --------------------------------------------------------: |
+| `/ai <instruction>` |                 Convert natural language to shell command |
+|   `/ask <question>` | Ask AI anything (coding, concepts, tips, general queries) |
+|             `/help` |                                         Show help message |
+|             `/info` |                                    Show basic system info |
+|          `/history` |                              View past generated commands |
+|            `/clear` |                                     Clear terminal screen |
+|   `exit` / `Ctrl+C` |                                            Exit Commandor |
+
+---
+
+## Examples
+
+```bash
+Commandor $ /ai list all .py files
+🤖 AI → find . -name "*.py" -type f
+
+Commandor $ /ask What is a virtual environment in Python?
+🤔 Thinking...
+
+🤖 AI Response:
+────────────────────────────────────────────
+A virtual environment isolates your Python packages ...
+────────────────────────────────────────────
+```
+
+---
+
+## Beautiful UI
+
+* Rainbow-colored ASCII logo on start
+* 🤖 & 💡 emojis for quick visual cues
+* Clear, color-coded prompts to separate AI and user input
+
+---
+
+## Troubleshooting
+
+✅ Command not found?
+
+* Ensure it’s installed: `pip show commandor`
+* Check your PATH: `echo $PATH`
+
+✅ API key issues?
+
+* Verify `.env` contains: `GEMINI=your_actual_key`
+* Key must be valid on [Google AI Studio](https://makersuite.google.com/app/apikey)
+
+✅ Windows users:
+
+```bash
+pip install pyreadline3
+```
+
+---
+
+## 🤝 Contribute
+
+We love contributions!
+
+* ⭐ Star the repo
+* 🐛 Report bugs / request features via [issues](https://github.com/ravin-d-27/Commandor/issues)
+* 📚 Improve docs
+* 🔧 Submit pull requests
+
+> Follow code style & add tests if you add features!
+
+---
+
+## License
+
+Open Source, free to use personally & commercially (with attribution):
+
+* Display **"Powered by Commandor"** if used commercially
+* Link back to this repo
+  See [LICENSE](LICENSE) for full details.
+
+---
+
+## ✏Author & Contact
+
+Made with ❤️ by **Ravin D**
+
+* Email: [ravin.d3107@outlook.com](mailto:ravin.d3107@outlook.com)
+
+---
+
+## Show your support
+
+If you find Commandor helpful:
+
+* Star this repository!
+* Share with fellow developers!
+
+---
+
+## Uninstall
+
+```bash
+pip uninstall commandor
+```
+
+---
+
+**Happy coding! 🚀**
+
+

commandor_ai-0.0.1/README.md

@@ -0,0 +1,172 @@
+# Commandor
+
+An intelligent terminal assistant that uses AI to **convert natural language into shell commands** and now **answers questions directly** with `/ask`.  
+Bring the power of AI to your terminal and work smarter!
+
+[![GitHub stars](https://img.shields.io/github/stars/ravin-d-27/Commandor?style=social)](https://github.com/ravin-d-27/Commandor/stargazers)
+[![License](https://img.shields.io/badge/License-Open%20Source%20with%20Attribution-blue.svg)](LICENSE)
+[![Python](https://img.shields.io/badge/Python-3.6%2B-blue.svg)](https://python.org)
+
+---
+
+
+## Key Features
+
+- **/ai** – Convert natural language instructions to shell commands
+- **/ask** – Ask AI anything: get explanations, coding help, system tips & more
+- **Beautiful interface** – Colorful ASCII art, emoji cues, color-coded prompts
+- **Context-aware** – Commands tailored to your current directory
+- **Safety checks** – Warn before running dangerous commands
+- **Command history** – Navigate with arrow keys (readline support)
+- **Cross-platform** – Works on Linux, macOS & Windows
+
+---
+
+## Installation
+
+### Clone & install (recommended)
+
+```bash
+git clone https://github.com/ravin-d-27/Commandor.git
+cd Commandor
+pip install -e .
+````
+
+### Set up your API key
+
+Get your Gemini API key from [Google AI Studio](https://makersuite.google.com/app/apikey):
+
+```bash
+echo "GEMINI=your_api_key_here" > ~/.env
+```
+
+Or set it directly:
+
+```bash
+export GEMINI=your_api_key_here
+```
+
+> **Windows tip:** Use `set GEMINI=your_api_key_here` instead
+
+---
+
+## Usage
+
+Run from any terminal:
+
+```bash
+commandor
+```
+
+---
+
+## 🛠️ Available Commands
+
+|             Command |                                              What it does |
+| ------------------: | --------------------------------------------------------: |
+| `/ai <instruction>` |                 Convert natural language to shell command |
+|   `/ask <question>` | Ask AI anything (coding, concepts, tips, general queries) |
+|             `/help` |                                         Show help message |
+|             `/info` |                                    Show basic system info |
+|          `/history` |                              View past generated commands |
+|            `/clear` |                                     Clear terminal screen |
+|   `exit` / `Ctrl+C` |                                            Exit Commandor |
+
+---
+
+## Examples
+
+```bash
+Commandor $ /ai list all .py files
+🤖 AI → find . -name "*.py" -type f
+
+Commandor $ /ask What is a virtual environment in Python?
+🤔 Thinking...
+
+🤖 AI Response:
+────────────────────────────────────────────
+A virtual environment isolates your Python packages ...
+────────────────────────────────────────────
+```
+
+---
+
+## Beautiful UI
+
+* Rainbow-colored ASCII logo on start
+* 🤖 & 💡 emojis for quick visual cues
+* Clear, color-coded prompts to separate AI and user input
+
+---
+
+## Troubleshooting
+
+✅ Command not found?
+
+* Ensure it’s installed: `pip show commandor`
+* Check your PATH: `echo $PATH`
+
+✅ API key issues?
+
+* Verify `.env` contains: `GEMINI=your_actual_key`
+* Key must be valid on [Google AI Studio](https://makersuite.google.com/app/apikey)
+
+✅ Windows users:
+
+```bash
+pip install pyreadline3
+```
+
+---
+
+## 🤝 Contribute
+
+We love contributions!
+
+* ⭐ Star the repo
+* 🐛 Report bugs / request features via [issues](https://github.com/ravin-d-27/Commandor/issues)
+* 📚 Improve docs
+* 🔧 Submit pull requests
+
+> Follow code style & add tests if you add features!
+
+---
+
+## License
+
+Open Source, free to use personally & commercially (with attribution):
+
+* Display **"Powered by Commandor"** if used commercially
+* Link back to this repo
+  See [LICENSE](LICENSE) for full details.
+
+---
+
+## ✏Author & Contact
+
+Made with ❤️ by **Ravin D**
+
+* Email: [ravin.d3107@outlook.com](mailto:ravin.d3107@outlook.com)
+
+---
+
+## Show your support
+
+If you find Commandor helpful:
+
+* Star this repository!
+* Share with fellow developers!
+
+---
+
+## Uninstall
+
+```bash
+pip uninstall commandor
+```
+
+---
+
+**Happy coding! 🚀**
+
+

commandor_ai-0.0.1/commandor/__init__.py

@@ -0,0 +1,11 @@
+"""
+Commandor - An intelligent terminal assistant that uses AI to convert natural language to shell commands.
+"""
+
+__version__ = "0.0.1"
+__author__ = "Ravin D"
+__email__ = "ravin.d3107@outlook.com"
+
+from .terminal import AITerminal
+
+__all__ = ["AITerminal"]

commandor_ai-0.0.1/commandor/main.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python3
+"""
+Commandor - An intelligent terminal assistant
+"""
+
+import sys
+from .terminal import AITerminal
+
+def main():
+    """Main entry point for the Commandor command."""
+    try:
+        terminal = AITerminal()
+        terminal.run()
+    except KeyboardInterrupt:
+        print("\n👋 Goodbye!")
+        sys.exit(0)
+    except Exception as e:
+        print(f"Error starting Commandor: {e}")
+        sys.exit(1)
+
+if __name__ == "__main__":
+    main()