Skip to main content

Console utility for integrating artificial intelligence into a Linux terminal.

Project description

Ai-eBash!

Python Version License: MIT PyPI Version GitHub Stars

Integrate artificial intelligence into your terminal. Ask questions to ChatGPT, Deep Seek, Grok and many other large language models (LLM). Execute scripts and commands suggested by the neural network directly from the command line. Perfect for beginners in Linux and Windows administration.

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

Table of Contents

Description

Features

  • Quick AI queries — Get answers from large language models via the command line
  • No GUI — Communicate with your chosen AI in natural language and any locale: ai how to install Russian fonts?
  • Interactive dialog mode — Chat with AI in dialog mode with preserved conversation context
  • Code execution — Execute scripts and commands suggested by AI in the console
  • Friendly interface — Formatted output with syntax highlighting — just like you’re used to when working with neural networks
  • Multiple AI providers — Support for OpenAI, OpenRouter, DeepSeek, Anthropic and other popular providers
  • Ready for localization — Multi-language support (in progress)

Quick Start

Install AI-eBash using one of the convenient methods.

Run the program → ai who are you?. In a couple of seconds, the neural network will respond:

program response1

Try something more complex:

program response2

On first launch, the program uses a Microsoft-hosted model — DeepSeek-R1-Lite-Preview with a public token. This is not the best option since you may see a quota-exceeded message due to high traffic, but it’s fine for a test run.

For full operation, you need to obtain a personal token and add it to the selected model in the program settings.

[!NOTE] AI-eBash can work with any neural network that supports API access. Today this includes almost all large language models (LLMs) on the market. How to add a new model.

Connecting to Neural Networks

AI-eBash ships with several popular models pre-configured, such as DeepSeek, Grok 4 Fast, Qwen3 Coder. However, provider policies don’t allow full operation without authorization. You must obtain a personal token (API_KEY) from the provider’s website.

Getting a Token (API_KEY) and Connecting to a Pre-installed Model

We recommend the provider OpenRouter — simple registration and dozens of popular models available for free with a single token.

  • Register on the website
  • Get a token by clicking Create API key. Save it — OpenRouter will show it only once!
  • Add the token to AI-eBash in the settings of the selected model
  • Make this model the current one

Done! Now the selected model will answer you in the console. You can connect any other model from this website in the same way.

[!NOTE] One OpenRouter token is valid for all models available from this provider.

A similar procedure applies to other providers, although with OpenRouter available, you may not need it.

Adding a New Model

To add a new model to AI-eBash, including a local model or one from major providers, simply enter in AI-eBash settings:

  • API_KEY (your personal token)
  • API_URL (API base URL)
  • model (model name)

You can find this information on the provider’s website in the API section.

Connection Example

Using the example of the free Meta: Llama 3.1 model listed on OpenRouter among dozens of other free models.

Open the model’s page and find the API section.

Among the connection examples, look for information similar to:

  • API_URL — for OpenRouter, this parameter is called base_url
  • model — listed as model

How to get API_KEY is described above.

Enter these values (without quotes) in AI-eBash settings and set this model as current. Now Meta: Llama 3.1 will answer your questions.

Installation

Ubuntu/Debian (pipx)

Recommended installation method

  1. Install pipx (if not installed):

    sudo apt update
    sudo apt install pipx python3-venv -y
    pipx ensurepath
    
  2. Restart the terminal

  3. Install AI-eBash:

    pipx install ai-ebash
    

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

pip install ai-ebash

Ubuntu/Debian (DEB Package)

  1. Download the latest DEB package from GitHub:

    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 the terminal

Windows (Experimental)

  1. Install Python 3.11+ (if not installed)

  2. Install AI-eBash:

    pip install ai-ebash
    
  3. Restart the terminal

Removal

If installed with pipx

pipx uninstall ai-ebash

If installed as DEB package

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

or you can also use dpkg:

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

If installed on Windows

pip uninstall ai-ebash

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)

And many others that support API access.

Configuration File

Settings are stored in:

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

Reset Settings

To restore defaults, delete the configuration file manually or run:

# For Linux
rm ~/.config/ai-ebash/config.yaml
# For Windows
rm %APPDATA%\ai-ebash\config.yaml

Examples

Quick Query

# Simple question
ai kernel update script

Dialog Mode

To start a dialog, use the -d key or simply type ai and press Enter. In dialog mode, AI-eBash preserves the conversation context throughout the session.

a i -d what python version is installed?
a i  # Enter

Running Code from AI Response

When in dialog mode, if the response contains code blocks — they are numbered. To run code, simply enter the block number in the console.

dialog mode

Security

[!WARNING] Never execute code suggested by the neural network if you’re not sure what it does!

Best Practices

  1. Review code before execution

    # Always check what AI suggests
    ai Delete all files from /tmp  # Don’t run this blindly!
    
  2. Use safe commands

    # Prefer these over destructive operations
    ai Show disk usage
    ai Show running processes
    

Contributing

I’ll be glad for any help!

Areas for Contribution

  • 🌍 Localization — Adding support for new languages, including README.md
  • 🤖 AI Providers — Integrating new AI providers
  • 🎨 UI/UX — Improving the configuration manager interface (yes, it’s not perfect)
  • 🔧 Tools — Creating additional utilities
  • 💡 Ideas — I welcome any ideas to improve and develop AI-eBash. Join the discussion

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 the 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

License

This project is licensed under the MIT License.

Contacts


Created with ❤️ for the Linux community

⭐ Star on GitHub

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ai_ebash-0.5.1.tar.gz (128.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ai_ebash-0.5.1-py3-none-any.whl (44.6 kB view details)

Uploaded Python 3

File details

Details for the file ai_ebash-0.5.1.tar.gz.

File metadata

  • Download URL: ai_ebash-0.5.1.tar.gz
  • Upload date:
  • Size: 128.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ai_ebash-0.5.1.tar.gz
Algorithm Hash digest
SHA256 dfd0664a7a71705263618540b237af946750716146365c6e1314426367293876
MD5 d045c8cefface7ed0a57c80e7ea17a14
BLAKE2b-256 63bf64f83d9f4d2a5a01748f58b12adcbfec9761019af19bcb2e9cc439675bc1

See more details on using hashes here.

File details

Details for the file ai_ebash-0.5.1-py3-none-any.whl.

File metadata

  • Download URL: ai_ebash-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 44.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ai_ebash-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9d3c14160191d8aab4822dfe4b1252c847ecee25ff7f5582a88fd7330994dedb
MD5 bbfa2ee55ad3b97585cc27001e1740da
BLAKE2b-256 c455e89f028116ba9aef7943e12c692ed2fe2b49c093c16ec6779b58c22bb095

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page