ai-ebash 0.4.5

Console utility for integrating artificial intelligence into a Linux terminal.

AI-eBash

Console utility for integrating artificial intelligence into your terminal. Ask AI questions and execute suggested scripts and commands directly from the command line. Perfect for beginners in Linux and Windows administration.

🌍 Available in: English | Русский

Table of Contents

• AI-eBash
  • Table of Contents
  • Features
  • Installation
    • Linux (pipx)
    • Linux (DEB Package)
    • Windows (Experimental)
  • Uninstall
    • If installed via pipx
    • If installed via DEB package
    • If installed via Windows:
  • Usage
    • Basic Usage
    • Dialog Mode
    • Code Execution
  • Configuration
    • Initial Setup
    • Supported AI Providers
    • Configuration File
  • Security
    • Best Practices
  • Contributing
    • Development Environment Setup
    • Contribution Guidelines
    • Areas for Contribution
  • License
  • Contacts

Features

• Fast AI Queries - Get instant responses from AI models through the command line
• Interactive Dialog Mode - Chat with AI in dialog mode with conversation context preservation
• Code Execution - Execute scripts and commands suggested by AI
• User-Friendly Interface - Formatted output with syntax highlighting
• Multiple AI Providers - Support for OpenAI, Anthropic and other providers
• Localization Ready - Support for multiple languages (in development)

Installation

Linux (pipx)

Recommended installation method for Linux

1. Install pipx (if not already installed):

   sudo apt update
   sudo apt install pipx python3-venv -y
   pipx ensurepath
   

2. Restart your terminal

3. Install AI-eBash:

   pipx install ai-ebash
   

Note: If pipx doesn't work, you can install via pip:

pip install ai-ebash

Linux (DEB Package)

1. Download the latest DEB package:

   wget -qO ai-ebash.deb $(wget -qO- https://api.github.com/repos/Vivatist/ai-ebash/releases/latest \
     | grep "browser_download_url.*\.deb" | cut -d '"' -f 4)
   

2. Install the package:

   sudo dpkg -i ./ai-ebash.deb
   sudo apt-get install -f -y
   

3. Restart your terminal

Windows (Experimental)

1. Install Python 3.11+ (if not already installed)

2. Install AI-eBash:

   pip install ai-ebash
   

3. Restart your terminal

Uninstall

To completely remove the utility:

If installed via pipx

pipx uninstall ai-ebash

If installed via DEB package

sudo apt remove python3-ai-ebash
# Or for complete deletion, including configuration files:
sudo apt purge python3-ai-ebash

or you can also use dpkg.:

sudo dpkg -r python3-ai-ebash
# Or for complete deletion, including configuration files:
sudo dpkg -P python3-ai-ebash

If installed via Windows:

pip uninstall ai-ebash

Usage

Basic Usage

# Simple question
ai What's today's date?

# Get help
ai --help

Dialog Mode

# Start interactive conversation
ai -d "Help me learn Python"

# In dialog mode you can:
# - Ask clarifying questions
# - Execute code blocks suggested by AI
# - Get command explanations

Code Execution

In dialog mode, AI responses may contain executable code blocks:

ai -d Show how to create a Python script

Then execute the suggested code by entering the block number:

[Code #1]

print("Hello, World!")

Configuration

Initial Setup

Run the setup mode to configure your AI provider:

ai -s

Supported AI Providers

• OpenAI (GPT-3.5, GPT-4)
• Anthropic (Claude)
• OpenRouter (Multiple models)
• Local Models (Ollama, LM Studio)

Configuration File

Settings are stored in:

• Linux: ~/.config/ai-ebash/config.json
• Windows: %APPDATA%\ai-ebash\config.json

Security

[!WARNING] Never execute code from untrusted sources without verification!

Best Practices

1. Verify code before execution

   # Always check what AI suggests
   ai "Delete all files from /tmp"  # Don't execute this blindly!
   

2. Use safe commands

   # Prefer these instead of destructive operations
   ai Show disk usage
   ai Show running processes
   

Contributing

I'd be happy to have your help! Here's how to get started:

Development Environment Setup

1. Fork the repository

2. Clone your fork:

   git clone https://github.com/your-username/ai-ebash.git
   cd ai-ebash
   

3. Set up development environment:

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   pip install -r requirements.txt
   pip install -e .
   

Contribution Guidelines

• 📝 Code Style: Follow PEP 8
• 🧪 Testing: Add tests for new features
• 📚 Documentation: Update README for new features
• 🔄 Pull Requests: Use clear commit messages

Areas for Contribution

• 🌍 Localization - Add support for new languages
• 🤖 AI Providers - Integrate new AI services
• 🎨 UI/UX - Improve terminal interface
• 📊 Analytics - Add usage statistics

License

This project is licensed under the MIT License.

Contacts

• Author: Andrey Bochkarev
• Email: [e-mail]
• GitHub Issues: Report bugs or request features
• Discussions: Join community discussions

---

Made with ❤️ for the Linux community

⭐ Star on GitHub • 🐛 Report issues • 💬 Join discussions