A smart terminal interface that understands natural language commands in English and Hinglish
Project description
Zyntax: Natural Language Terminal Interface
Zyntax is an intelligent terminal interface that understands natural language commands. Skip memorizing complex command syntax across different operating systems - just tell Zyntax what you want to do in plain English or Hinglish.
Zyntax bridges the gap between human language and command-line interfaces, making terminal operations accessible to everyone while maintaining the power and efficiency developers love.
🔥 Cross-platform: Works consistently on Linux, macOS, and Windows
🧠 Smart parsing: Advanced NLP with spaCy for accurate intent recognition in English and Hinglish
⚡ Fast: Optimized for real-time command processing
🛠 Extensible: Built with modularity and extensibility in mind
✨ Features
- Multilingual Support: Works with English and Hinglish commands
- Natural Language Processing: Advanced command understanding using spaCy
- Cross-Platform Compatibility: Unified interface across Linux, macOS, and Windows
- Smart Command Mapping: Automatically translates to platform-specific commands
- File Operations: Create, move, copy, delete files and directories naturally
- Git Integration: Manage repositories with conversational commands
- System Information: Check memory, disk usage, and system status
- Error Handling: Clear feedback and graceful error recovery
🚀 Quick Start
Installation
pip install zyntax
Note: The required spaCy language model will be downloaded automatically on first run.
Usage
zyntax
🚀 Zyntax - Natural Language Terminal
💬 Type commands in natural language (English/Hinglish). Type 'exit' to quit.
Zyntax> create a new folder called my_project
Zyntax> change directory to my_project
Zyntax> make an empty file named README.md
Zyntax> folder banao docs
Zyntax> what's the git status?
📖 Command Examples
| Natural Language | Traditional Command |
|---|---|
list all files |
ls -la / dir |
show current directory |
pwd / cd |
create folder called docs |
mkdir docs / md docs |
folder banao my_project |
mkdir my_project |
copy file.txt to backup/ |
cp file.txt backup/ / copy file.txt backup\ |
remove old_file.txt |
rm old_file.txt / del old_file.txt |
show memory usage |
System info via psutil |
git commit with message "fix bug" |
git commit -m "fix bug" |
🛠 Supported Operations
- File Management: Create, read, copy, move, delete files
- Directory Navigation: Change directories, show current path
- Git Operations: Status, init, commit with message parsing
- System Information: Memory usage, user info, process management
- Text Operations: Display file contents, basic text manipulation
💻 Platform Support
| Platform | Status | Notes |
|---|---|---|
| Linux | ✅ Full Support | Native command mapping |
| macOS | ✅ Full Support | Uses Linux commands with macOS compatibility |
| Windows | ✅ Full Support | Automatic CMD/PowerShell translation |
📋 Requirements
- Python: 3.8 or higher
- Operating System: Linux, macOS, or Windows
- Dependencies: spaCy, rapidfuzz, psutil
- Language Model: en_core_web_sm (downloaded automatically)
🔧 Installation Details
Using pip (Recommended)
pip install zyntax
The spaCy language model will be downloaded automatically on first run. If you prefer to download it manually beforehand:
python -m spacy download en_core_web_sm
From Source
git clone https://github.com/racxhit/Zyntax.git
cd Zyntax
pip install -e .
🎯 Use Cases
- Beginners: Learn command-line operations without memorizing syntax
- Cross-platform developers: Use consistent commands across different systems
- Automation: Natural language scripting and task automation
- Education: Teaching terminal concepts with intuitive language
- Productivity: Faster command execution with conversational interface
🤝 Contributing
We welcome contributions! Please see our contributing guidelines for details.
Development Setup
git clone https://github.com/racxhit/Zyntax.git
cd Zyntax
pip install -e ".[dev]"
pytest tests/
📝 License
This project is licensed under the MIT License - see the LICENSE file for details.
🙏 Acknowledgments
- Built with spaCy for natural language processing
- Uses rapidfuzz for fuzzy string matching
- System operations powered by psutil
🔗 Links
- Documentation: GitHub Wiki
- Bug Reports: GitHub Issues
- Feature Requests: GitHub Discussions
- PyPI Package: https://pypi.org/project/zyntax/
Made with ❤️ for developers who believe terminals should speak human
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file zyntax-1.0.2.tar.gz.
File metadata
- Download URL: zyntax-1.0.2.tar.gz
- Upload date:
- Size: 26.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dc74c4ba64501bf6804126277f9cc80ee5af1c65ac24f2a00149be9b200ba3af
|
|
| MD5 |
7e96a85916cbd06e48ec837f05e4f24b
|
|
| BLAKE2b-256 |
dd2255c71c69a8e311a3263861febd797621ac1fda1252102ad739cdd1457771
|
File details
Details for the file zyntax-1.0.2-py3-none-any.whl.
File metadata
- Download URL: zyntax-1.0.2-py3-none-any.whl
- Upload date:
- Size: 24.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
75e0b04a3e828af61c3bb50ec833c1a9f83bfba136dbb86af18d4ae15264e161
|
|
| MD5 |
23842a7577859879ba4dadd98ca0ac9b
|
|
| BLAKE2b-256 |
b58ceb140717903406a9e8d6566187113b793d0a72978b3e9df705b216e30978
|