Skip to main content

🤖 AI Bot Agent - Intelligent command line assistant with chat, code generation, file analysis, and web search capabilities

Project description

🤖 AI Bot Agent

A powerful AI assistant that runs from the command line with various capabilities including chat, code generation, file analysis, and web search.

Features

  • Multi-Provider Support: Use OpenAI, Free AI, or Hugging Face models
  • Interactive Chat Mode: Have conversations with the AI
  • Code Generation: Generate code from natural language descriptions
  • File Analysis: Analyze and get insights about your files
  • Web Search: Search for information on the web
  • Rich CLI Interface: Beautiful terminal interface with colors and formatting
  • Conversation History: Maintains context across interactions
  • Easy Setup: Automated provider configuration with fallback options
  • Free Tier Available: Start using immediately without API keys

Installation

Prerequisites

  • Python 3.8 or higher
  • OpenAI API key (optional - free tier available)

Quick Start

Option 1: Homebrew (Recommended for macOS)

# Install via Homebrew
brew install ai-bot-agent

# Set up your API key
ai setup

# Start using the bot
ai chat

Option 2: PyPI

# Install the package
pip install ai-bot-agent

# Set up your API key
ai-bot setup

This will:

  • Show available AI providers (OpenAI, Free AI, Hugging Face)
  • Guide you through setting up your preferred provider
  • Test and save your configuration automatically

Option 3: Source Installation

git clone https://github.com/thiennp/cli-smart.git
cd cli-smart
pip install -r requirements.txt
python main.py setup

Usage

Easy Setup

Set up your AI providers with automated assistance:

# With Homebrew installation
ai setup

# With PyPI installation
ai-bot setup

This command will:

  • Show available AI providers and their status
  • Guide you through setting up your preferred provider
  • Test the configuration to ensure it works
  • Save it securely to your .env file

Check Provider Status

View the status of all available AI providers:

# With Homebrew installation
ai status

# With PyPI installation
ai-bot status

Interactive Chat Mode

Start an interactive conversation with the AI:

# With Homebrew installation
ai chat

# With PyPI installation
ai-bot chat

Ask a Single Question

Ask a specific question:

# With Homebrew installation
ai ask "What is machine learning?"

# With PyPI installation
ai-bot ask "What is machine learning?"

Generate Code

Generate code from a description:

# With Homebrew installation
ai code "Create a simple web scraper"

# With PyPI installation
ai-bot code "Create a simple web scraper"

Generate code in a specific language:

# With Homebrew installation
ai code "Create a REST API" --lang javascript

# With PyPI installation
ai-bot code "Create a REST API" --lang javascript

Analyze Files

Analyze a file and get insights:

# With Homebrew installation
ai analyze main.py

# With PyPI installation
ai-bot analyze main.py

Search the Web

Search for information:

# With Homebrew installation
ai search "latest Python features"

# With PyPI installation
ai-bot search "latest Python features"

Clear History

Clear conversation history:

# With Homebrew installation
ai clear

# With PyPI installation
ai-bot clear

Get Help

Show help information:

# With Homebrew installation
ai help

# With PyPI installation
ai-bot help

AI Providers

The AI Bot Agent supports multiple AI providers, allowing you to choose the best option for your needs:

OpenAI (Recommended)

  • Best AI capabilities with GPT-3.5-turbo and GPT-4
  • Full conversation context and memory
  • Advanced code generation and analysis
  • Requires API key (free tier available)

Free AI Service

  • No setup required - works immediately
  • Limited but helpful responses for basic questions
  • Perfect for testing or when you don't have an API key
  • Keyword-based responses for common topics

Hugging Face (Coming Soon)

  • Local model support for privacy
  • Custom model selection
  • Offline capabilities

Configuration

The setup command automatically creates a .env file with your configuration:

OPENAI_API_KEY=your_openai_api_key_here

You can also manually edit the .env file to customize:

# OpenAI API Configuration
OPENAI_API_KEY=your_openai_api_key_here

# Optional: Customize the AI model
OPENAI_MODEL=gpt-3.5-turbo

# Optional: Set default temperature for responses
OPENAI_TEMPERATURE=0.7

# Optional: Set maximum tokens for responses
OPENAI_MAX_TOKENS=1000

Examples

Chat Mode Examples

You: What is Python?
AI Bot: Python is a high-level, interpreted programming language...

You: Write a function to calculate fibonacci numbers
AI Bot: Here's a Python function to calculate Fibonacci numbers...

You: Explain machine learning in simple terms
AI Bot: Machine learning is like teaching a computer to learn...

Code Generation Examples

# Generate a Python web scraper
ai code "Create a web scraper that extracts titles from a news website"

# Generate a JavaScript function
ai code "Create a function to validate email addresses" --lang javascript

# Generate a data analysis script
ai code "Create a script to analyze CSV data and create visualizations"

Features in Detail

Easy Setup

  • Automated browser opening to OpenAI API key page
  • Step-by-step guidance for API key creation
  • Automatic validation and testing of API keys
  • Secure storage in .env file

Interactive Chat Mode

  • Maintains conversation context
  • Rich formatting with colors
  • Easy-to-use interface
  • Built-in commands (exit, clear, help)

Code Generation

  • Supports multiple programming languages
  • Generates complete, working code
  • Includes explanations and usage examples
  • Optimized for different use cases

File Analysis

  • Analyzes code structure and purpose
  • Identifies potential issues
  • Provides improvement suggestions
  • Works with various file types

Web Search

  • Search for current information
  • Get real-time data
  • Research capabilities
  • Information gathering

Installation Options

1. Homebrew (macOS)

brew install ai-bot-agent
ai setup
ai chat

2. PyPI (All Platforms)

pip install ai-bot-agent
ai-bot setup
ai-bot chat

3. Source (Development)

git clone https://github.com/thiennp/cli-smart.git
cd cli-smart
pip install -r requirements.txt
python main.py setup
python main.py chat

Troubleshooting

Common Issues

  1. API Key Error

    Error: OpenAI client not initialized. Please check your API key.
    

    Solution: Run ai setup or ai-bot setup to configure your API key

  2. Module Not Found

    ModuleNotFoundError: No module named 'openai'
    

    Solution: Install dependencies with pip install ai-bot-agent

  3. Permission Denied

    PermissionError: [Errno 13] Permission denied
    

    Solution: Make sure the script is executable: chmod +x main.py

Getting Help

  • Use ai help or ai-bot help for command help
  • Use ai --help or ai-bot --help for general help
  • Check the logs for detailed error messages

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests if applicable
  5. Submit a pull request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • Built with Typer for CLI
  • Styled with Rich for beautiful terminal output
  • Powered by OpenAI API

Version History

  • v1.0.0: Initial release with basic chat, code generation, and file analysis features
  • v1.1.0: Added automated setup command for easy API key configuration

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_bot_agent-1.2.0.tar.gz (15.4 kB view details)

Uploaded Source

Built Distribution

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

ai_bot_agent-1.2.0-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file ai_bot_agent-1.2.0.tar.gz.

File metadata

  • Download URL: ai_bot_agent-1.2.0.tar.gz
  • Upload date:
  • Size: 15.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for ai_bot_agent-1.2.0.tar.gz
Algorithm Hash digest
SHA256 4b71f0362fa29677caf3b9d158721b428923f0f5f6ba1ee2c2f9d7e6361fc4ef
MD5 c1fba11c5e1c7e629b524e1aa7d227cd
BLAKE2b-256 c35536c948c1f4a10f362009f377ff4ccda1c544dd20a2886c8c15af43fa1457

See more details on using hashes here.

File details

Details for the file ai_bot_agent-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: ai_bot_agent-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 12.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for ai_bot_agent-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bab837b53c6cb7ac4cb6e75828474fefe89fd13ad8d98aad871cfad953d802f0
MD5 168b4bb90ddc855b2ff3bba09d466528
BLAKE2b-256 a592f3c3358f929cd8663be316fa73d7b83069d7c82781baee5cf6384d0b7e30

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