AI-Powered Terminal Command Generator and Executor
Project description
Smart Terminal
Smart Terminal (st) is a powerful command-line interface that converts natural language instructions into executable terminal commands using AI. Say goodbye to forgetting command syntax or searching through documentation - just describe what you want to do in plain English.
🚀 Features
- Natural Language Processing: Convert plain English to terminal commands
- Multi-step Tasks: Handle complex operations with sequential commands
- Cross-platform Support: Works across macOS, Linux, and Windows
- Interactive Mode: Continuous command generation for complex workflows
- Command History: Context-aware interactions for better suggestions
- Admin Privilege Handling: Proper sudo/admin permission management
- Customizable: Configure AI providers and other settings
⚡ Quick Installation
pip install smart-terminal-cli
📖 Usage
Basic Command Conversion
st "create a folder called projects and create a python file inside it"
This will generate and execute the appropriate commands to create the folder and file.
Interactive Mode
st -i
Start an interactive session where you can continuously issue natural language commands.
Setup and Configuration
st --setup
Configure API keys, default settings, and other options.
Other Commands
# Clear command history
st --clear-history
# Enable debug logging
st --debug
# View version information
st --version
📋 Examples
Here are some examples of what you can do with Smart Terminal:
# File and directory operations
st "find all PDF files in the current directory and move them to a new folder called documents"
# System information
st "show me system information including CPU and memory usage"
# Package management
st "install numpy, pandas, and matplotlib for my python project"
# Git operations
st "initialize a git repository, add all files, and make an initial commit"
# Network operations
st "scan open ports on localhost"
🔧 Configuration
Smart Terminal stores its configuration in ~/.smartterminal/config.json. You can modify this file directly or use the setup command:
st --setup
Key configuration options:
- API Key: Your AI service API key
- Base URL: API endpoint URL
- Model Name: AI model to use for command generation
- Default OS: Target operating system for commands
- History Limit: Number of previous commands to retain
🛠️ Development
Prerequisites
- Python 3.10 or higher
- Poetry (for dependency management)
Setting up development environment
# Clone the repository
git clone https://github.com/muralianand12345/Smart-Terminal.git
cd Smart-Terminal
# Install dependencies using Poetry
poetry install
# Activate the virtual environment
poetry shell
Building from source
poetry build
📜 License
This project is licensed under the MIT License - see the LICENSE file for details.
🙏 Acknowledgements
- OpenAI/Groq for providing the AI capabilities
- All contributors and testers
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
Created by Murali Anand
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 smart_terminal_cli-1.2.0.tar.gz.
File metadata
- Download URL: smart_terminal_cli-1.2.0.tar.gz
- Upload date:
- Size: 22.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.10.11 Darwin/24.3.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0e580754cde6e7578657a6428f72b5f608839101de951f788bc043193d6e8895
|
|
| MD5 |
03bfe30bbdc1c0c9c565e32b584b51fc
|
|
| BLAKE2b-256 |
7b6186107338dc26836574496d0b593cf3451fb3c65da8af508d8b7b721e1659
|
File details
Details for the file smart_terminal_cli-1.2.0-py3-none-any.whl.
File metadata
- Download URL: smart_terminal_cli-1.2.0-py3-none-any.whl
- Upload date:
- Size: 25.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.10.11 Darwin/24.3.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dd6815381ead91a6f4f7db0a5adf49179fdaef02f73a9da7ff5b75fc8bf4419c
|
|
| MD5 |
a2aed7b9ac21b9668b30abc9dd4157d2
|
|
| BLAKE2b-256 |
667888d5091760a523c3d4b3ddcce4c02de50001852d4784e29eddfb5297141d
|