🚀 ZynoxAI - AI-Powered Automation Tool

Create files and folders using natural language with GPT, Gemini, Grok, and DeepSeek AI

Features • Installation • Quick Start • Usage Guide • Examples • Telegram Bot

📋 Table of Contents

What is ZynoxAI?
Features
Supported AI Providers
Installation
Configuration
Quick Start
Usage Guide
Examples
Commands Reference
Telegram Bot
Smart Installation
Memory & Sessions
Troubleshooting
API Keys
Project Structure
Contributing

🤖 What is ZynoxAI?

ZynoxAI is a command-line tool that leverages artificial intelligence to create files and folders based on natural language descriptions. Instead of manually typing mkdir, touch, and writing file contents, you can simply describe what you want in plain English, and ZynoxAI will:

Parse your request using AI (GPT, Gemini, Grok, or DeepSeek)
Generate appropriate file/folder structures
Create them automatically on your filesystem
Execute system commands intelligently
Auto-install missing packages

Use Cases

Rapid Prototyping: Create complete project structures instantly
Learning: Generate code examples and tutorials
Automation: Script file generation without complex templates
Mobile Development: Run on Termux for on-the-go development
Documentation: Quickly create README, config files, and documentation
Remote Control: Use Telegram bot to control from anywhere

✨ Features

Core Features

🤖 Multi-AI Support - Switch between OpenAI GPT, Google Gemini, Grok (xAI), and DeepSeek
🌐 Natural Language - Describe what you want in plain English
📁 Batch Operations - Create multiple files/folders in one command
🎨 Nested Structures - Automatically creates parent directories
🎯 Smart File Detection - AI understands file types and extensions
📝 Code Generation - Creates meaningful code content automatically
🎨 Color Output - Beautiful terminal interface with colored logs
💾 Persistent Config - Saves API keys and preferences locally
🧠 Memory System - Remembers previous conversations and context
💬 Telegram Bot - Control ZynoxAI remotely via Telegram
🔧 Smart Installation - Auto-detects and installs missing packages

Technical Features

✅ Zero Dependencies - Only requires Python and requests
🔄 Retry Logic - Automatic retry on network failures
⏱️ Configurable Timeout - Handles slow connections gracefully
🔐 Secure - API keys stored locally, never transmitted elsewhere
📱 Termux Optimized - Works perfectly on Android devices
🌍 Cross-Platform - Works on Termux, Linux, macOS, Windows

🧠 Supported AI Providers

Provider	Models	Best For	Token Limit
OpenAI	`gpt-3.5-turbo` `gpt-4o-mini` `gpt-4o`	General purpose, high quality	8K-16K
Gemini	`gemini-1.5-flash` `gemini-1.5-pro` `gemini-2.0-flash-exp`	Real-time, code, high quality	8K
Grok	`grok-beta` `grok-2-1212` `grok-2-vision-1212`	Real-time, witty responses	8K
DeepSeek	`deepseek-chat` `deepseek-coder`	Code generation, cost-effective	128K

📦 Installation

Prerequisites

Python 3.7 or higher
pip (Python package manager)
Internet connection (for API calls)

Step 1: Install Dependencies

# Update package manager
pkg update && pkg upgrade  # For Termux
# OR
sudo apt update && sudo apt upgrade  # For Linux

# Install Python if not installed
pkg install python  # Termux
# OR
sudo apt install python3  # Linux

# Install required Python packages
pip install requests colorama

Step 2: Clone/Create ZynoxAI

# Download the script
git clone https://github.com/BugeStudioTeam/Zynox.git

# Rename
mv Zynox ZynoxAI

cd ~/ZynoxAI

Step 3: Set Up Alias (Optional but Recommended)

# Add alias to ~/.bashrc
echo "alias zynox='python ~/ZynoxAI/zynox.py'" >> ~/.bashrc
source ~/.bashrc

# Or for Termux with ~/bin directory
mkdir -p ~/bin
ln -s ~/ZynoxAI/zynox.py ~/bin/zynox
chmod +x ~/ZynoxAI/zynox.py

Step 4: Verify Installation

# Should show the ZYNOX logo
zynox

# Should show help menu
zynox --help

# Should show about menu
zynox --about

🔧 Configuration

Setting API Keys

You need to set API keys for the providers you want to use:

# OpenAI (get from: https://platform.openai.com/api-keys)
zynox --set-key openai --key sk-your-openai-key

# Gemini (get from: https://aistudio.google.com/app/apikey)
zynox --set-key gemini --key YOUR_GEMINI_API_KEY

# Grok/xAI (get from: https://console.x.ai/)
zynox --set-key grok --key xai-your-grok-key

# DeepSeek (get from: https://platform.deepseek.com/api_keys)
zynox --set-key deepseek --key sk-your-deepseek-key

Setting Default Provider

# Set OpenAI as default
zynox --set-default openai

# Set Gemini as default
zynox --set-default gemini

# Set Grok as default
zynox --set-default grok

# Set DeepSeek as default
zynox --set-default deepseek

Viewing Configuration

# Show current settings
zynox --show-config

Example Output:

Current Configuration:
  Default Provider: deepseek
  Default Model: deepseek-chat
  Configured APIs: openai, deepseek

Configuration File Location

~/.zynoxai/config.json

Example config.json:

{
  "api_keys": {
    "openai": "sk-xxx",
    "deepseek": "sk-yyy"
  },
  "default_provider": "deepseek",
  "default_model": "deepseek-chat"
}

🚀 Quick Start

Basic Usage

# Create a single file
zynox "create a hello.txt file"

# Create a folder
zynox "create a folder called my_project"

# Create a file with content
zynox "create a python file called hello.py with print('Hello World')"

# Create multiple items
zynox "create a web project with index.html, style.css, and script.js"

Using Specific Providers

# Use OpenAI
zynox -p openai "create a config.json file"

# Use Gemini
zynox -p gemini "create a index.html file"

# Use Grok
zynox -p grok "create a bash script called backup.sh"

# Use DeepSeek with specific model
zynox -p deepseek -m deepseek-coder "create a python api server"

Working in Different Directories

# Create in current directory (default)
zynox "create test.txt"

# Create in specific directory
zynox -d ./myapp "create main.py and requirements.txt"

# Create in absolute path (Termux shared storage)
zynox -d /sdcard/Documents "create notes.txt"

📚 Usage Guide

Command Structure

zynox [OPTIONS] "YOUR NATURAL LANGUAGE REQUEST"

Options

Option Description Example -p, --provider AI provider to use -p openai, -p deepseek -m, --model Specific model name -m gpt-4o, -m deepseek-chat -d, --dir Base directory for creation -d ./project --set-key Set API key for provider --set-key openai --key sk-xxx --set-default Set default provider --set-default deepseek --list-models Show available models --list-models --show-config Show current configuration --show-config --new-session Start new conversation session --new-session --list-sessions List all saved sessions --list-sessions --load-session Load a previous session --load-session ID --delete-session Delete a session --delete-session ID --clear-memory Clear current session memory --clear-memory -h, --help Show help message --help

Provider-Specific Tips

OpenAI

· Best for general purpose · Higher cost but excellent quality · Use gpt-4o for complex projects · Use gpt-3.5-turbo for simple tasks

Gemini

· Free tier available · Great for code generation · Fast response times · Use gemini-1.5-flash for speed

Grok (xAI)

· Great for real-time interactions · Unique personality and style · 8K token limit

DeepSeek

· Best for code generation · Very cost-effective · 128K context window (largest) · Use deepseek-coder for programming tasks

Web page

#Start Server
zynox --web

Go to your browser and visit: http://127.0.0.1:5000/

💡 Examples

Web Development Projects

# Create a complete HTML/CSS/JS project
zynox "create a modern website with index.html, styles.css, script.js, and an assets folder"

# Create a React component
zynox "create a React component called Button.jsx with props for onClick and children"

# Create a REST API
zynox -p deepseek -m deepseek-coder "create a Flask API with endpoints for GET, POST, and DELETE"

Programming Projects

# Python project structure
zynox "create a Python package with setup.py, README.md, requirements.txt, and src folder with __init__.py"

# Command-line tool
zynox "create a Python CLI tool with argparse that takes a filename and prints its contents"

# Data science project
zynox "create a Jupyter notebook with pandas and matplotlib imports"

System Administration

# Create backup scripts
zynox "create a bash script that backs up my Downloads folder"

# Configuration files
zynox "create a docker-compose.yml file with nginx and mysql"

# Execute commands
zynox "list all files in current directory"
zynox "show disk usage"

File Operations

# Search and read files
zynox "find abc.txt and read it"

# Create based on existing files
zynox "find config.yml and create a similar python script"

# Batch operations
zynox "create a zip file with all python files"

📖 Commands Reference

Configuration Commands

# Set API keys
zynox --set-key openai --key sk-xxx
zynox --set-key gemini --key YOUR_GEMINI_API_KEY
zynox --set-key grok --key xai-xxx
zynox --set-key deepseek --key sk-xxx

# Set defaults
zynox --set-default openai
zynox --set-default gemini
zynox --set-default grok
zynox --set-default deepseek

# View settings
zynox --show-config
zynox --list-models

Session Management Commands

# Start new conversation
zynox --new-session

# List all saved sessions
zynox --list-sessions

# Load a previous session
zynox --load-session session_20241208_143022

# Delete a session
zynox --delete-session session_20241208_143022

# Clear current memory
zynox --clear-memory

Creation Commands

# Single file
zynox "create a file called example.txt"
zynox "create a text file with content 'Hello World'"

# Single folder
zynox "create a folder called my_directory"
zynox "make a directory named src"

# Multiple items
zynox "create a folder named data and inside it create input.txt and output.txt"
zynox "create index.html, about.html, and contact.html files"

# Nested structures
zynox "create src/utils/helpers.py with a helper function"
zynox "create project/css/style.css with basic styling"

Advanced Usage

# Specify provider and model
zynox -p deepseek -m deepseek-coder "create an algorithm for fibonacci"

# Work in specific directory
zynox -d ~/Desktop "create a shortcut.sh file"

# Combination
zynox -p openai -d ./api "create a REST API with Flask"

💬 Telegram Bot

What is the Telegram Bot?

ZynoxAI includes a Telegram bot that allows you to control the tool remotely from your phone or any device with Telegram. You can create files, run commands, and manage your projects from anywhere.

Setting Up the Telegram Bot

Create a bot with BotFather · Open Telegram and search for @BotFather · Send /newbot and follow the instructions · Copy the bot token (format: 1234567890:ABCdefGHIJKLMNopqRsTUVwxyz)
Install Telegram dependency

pip install python-telegram-bot

1. Start the bot

python zynox.py --telegram-bot YOUR_BOT_TOKEN

Telegram Bot Commands

Command Description /start Show welcome message /help Show help menu /status Show bot and system status /new Start new conversation session /clear Clear current memory /history Show conversation history /list List files in current directory /pwd Show current working directory /cd Change directory

Using the Telegram Bot

Simply send any natural language request to your bot:

User: "create a python file called test.py with print('Hello')"
Bot: [Executes and returns result]

User: "find abc.txt and read it"
Bot: [Searches and displays content]

User: "list all files"
Bot: [Shows directory listing]

Running Bot in Background (Termux)

# Run in background
nohup python zynox.py --telegram-bot YOUR_BOT_TOKEN > bot.log 2>&1 &

# Check logs
tail -f bot.log

# Stop bot
pkill -f "zynox.py"

Security

· First user who interacts with the bot becomes admin · Admin can authorize other users with /authorize <user_id> · All commands require authorization (except first user)

🔧 Smart Installation

Automatic Package Detection

ZynoxAI automatically detects when a command is not available and offers to install it:

[Executing: zip files.zip *.txt]
[Package 'zip' not found]
Try to smart install 'zip'? (y/N): y
[Installing zip...]
[Installed zip successfully]
[Command executed successfully]

Supported Package Managers

Environment Package Manager Termux pkg Debian/Ubuntu apt RHEL/CentOS yum/dnf Arch Linux pacman macOS brew

Special Tool Installation

ZynoxAI can automatically install specialized tools:

· apktool - For APK decompilation (auto-downloads from GitHub) · jadx - For Java/Android decompilation · dex2jar - For DEX to JAR conversion

Manual Installation Fallback

If automatic installation fails, ZynoxAI provides manual instructions:

[Could not auto-install apktool]
[Please manually install: pkg search apktool or search online]

🧠 Memory & Sessions

How Memory Works

ZynoxAI remembers your conversation context across multiple commands:

# First command
zynox "find abc.txt"
[Found: ./ZynoxAI/abc.txt]

# Second command (remembers previous)
zynox "read it"
[Read: ./ZynoxAI/abc.txt (123 bytes)]

Session Management

# Start a fresh session
zynox --new-session

# List all saved sessions
zynox --list-sessions
# Output:
#   session_20241208_143022 - 5 msgs - 2024-12-08T14:30:22
#   session_20241207_091345 - 12 msgs - 2024-12-07T09:13:45

# Load a previous session
zynox --load-session session_20241208_143022

# Delete a session
zynox --delete-session session_20241207_091345

# Clear current memory
zynox --clear-memory

Session Storage

Sessions are stored in ~/.zynoxai/memories/ as JSON files. Each session contains:

· Session ID and creation timestamp · Full conversation history · Message timestamps

🔍 Troubleshooting

Common Issues and Solutions

1. Permission Denied Error

Error:

bash: /data/data/com.termux/files/home/bin/zynox: Permission denied

Solution:

# Use alias instead
echo "alias zynox='python ~/ZynoxAI/zynox.py'" >> ~/.bashrc
source ~/.bashrc

2. API 400 Error (DeepSeek)

Error:

✗ HTTP 400 Error: model: invalid type: null

Solution:

# Always specify model
zynox -p deepseek -m deepseek-chat "create file"

3. Timeout Error

Error:

✗ Request timeout

Solution:

# Use a different provider
zynox -p openai "create file"
# Or simplify your request
zynox "create a simple text file"

4. JSON Parse Error

Error:

✗ Failed to parse AI response: Unterminated string

Solution:

# Simplify your request
zynox "create a simple text file"  # Instead of complex HTML

5. API Key Not Working

Solution:

# Verify key is set
zynox --show-config

# Re-set the key
zynox --set-key deepseek --key sk-new-key

# Check key validity (curl test)
curl -X POST https://api.deepseek.com/v1/chat/completions \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "deepseek-chat", "messages": [{"role": "user", "content": "Hi"}]}'

6. Telegram Bot Not Starting

Error:

RuntimeError: set_wakeup_fd only works in main thread

Solution: Use the fixed version that runs bot in main thread (included in the code).

Debug Mode

# Run with full Python error output
python ~/ZynoxAI/zynox.py "test" 2>&1

# Check raw API response (edit zynox.py to print response.text)

🔑 API Keys

Where to Get API Keys

Provider Sign Up URL Cost Free Tier OpenAI platform.openai.com Pay-as-you-go $5 free credit Gemini aistudio.google.com Pay-as-you-go Free tier available Grok (xAI) console.x.ai Pay-as-you-go Limited free DeepSeek platform.deepseek.com Very cheap ¥10M free tokens

Setting Up API Keys

Create an account at the provider's website
Navigate to API Keys section
Generate a new API key
Copy the key (starts with sk- typically for OpenAI/DeepSeek)
Set it in ZynoxAI: zynox --set-key PROVIDER --key YOUR_KEY

Security Best Practices

· ✅ Store keys only in local config file · ✅ Never commit config.json to git · ✅ Use environment variables for CI/CD · ✅ Rotate keys periodically · ❌ Don't share your keys publicly · ❌ Don't hardcode keys in scripts

📁 Project Structure

ZynoxAI/
├── zynox.py
├── __init__.py
├── __main__.py
├── requirements.txt
├── output/
│   ├── create/
│   ├── logs/
│   ├── cache/
│   └── temp/
└── src/
    └── zynox/
        ├── __init__.py
        ├── __version__.py
        ├── cli.py
        ├── config.py
        ├── constants.py
        ├── exceptions.py
        ├── utils/
        │   ├── __init__.py
        │   ├── colors.py
        │   ├── helpers.py
        │   └── logger.py
        ├── memory/
        │   ├── __init__.py
        │   └── session.py
        ├── core/
        │   ├── __init__.py
        │   ├── ai_providers/
        │   │   ├── __init__.py
        │   │   ├── base.py
        │   │   ├── openai.py
        │   │   ├── gemini.py
        │   │   ├── grok.py
        │   │   ├── deepseek.py
        │   │   └── factory.py
        │   ├── command/
        │   │   ├── __init__.py
        │   │   ├── executor.py
        │   │   └── installer.py
        │   ├── file/
        │   │   ├── __init__.py
        │   │   ├── manager.py
        │   │   └── search.py
        │   └── prompt/
        │       ├── __init__.py
        │       └── builder.py
        └── bot/
            ├── __init__.py
            └── telegram.py

ZynoxAI File Descriptions

Root Directory

File	Description
`zynox.py`	Main entry point, CLI launcher
`__init__.py`	Package initializer, exports version
`__main__.py`	Allows `python -m zynox` execution
`requirements.txt`	Python dependencies list

src/zynox/

File	Description
`__init__.py`	Core package initializer
`__version__.py`	Version, author, license info
`cli.py`	Main CLI logic, argument parsing, request handling
`config.py`	Configuration management, file paths, API keys
`constants.py`	API endpoints, shell builtins, package mappings
`exceptions.py`	Custom exception classes

src/zynox/utils/

File	Description
`colors.py`	Color output functions, logo, about info
`helpers.py`	Environment detection, package manager detection
`logger.py`	Logging setup and configuration

src/zynox/memory/

File	Description
`session.py`	Conversation memory, session save/load, history

src/zynox/core/ai_providers/

File	Description
`base.py`	Abstract base class for all AI providers
`openai.py`	OpenAI GPT API integration
`gemini.py`	Google Gemini API integration
`grok.py`	xAI Grok API integration
`deepseek.py`	DeepSeek API integration
`factory.py`	Factory pattern for creating AI instances

src/zynox/core/command/

File	Description
`executor.py`	System command execution with environment awareness
`installer.py`	Smart package installation, apktool installer

src/zynox/core/file/

File	Description
`manager.py`	File/folder creation, reading, listing, deletion
`search.py`	File and folder search using find command

src/zynox/core/prompt/

File	Description
`builder.py`	AI prompt construction with context

src/zynox/bot/

File	Description
`telegram.py`	Telegram bot handler, commands, user authorization

Output Directories (auto-created)

Directory	Description
`output/create/`	All created files and folders go here
`output/logs/`	Application log files
`output/cache/`	Temporary cached data
`output/temp/`	Temporary working files

Config Directories (auto-created at ~/.zynoxai/)

File/Dir	Description
`config.json`	API keys and provider settings
`memories/`	Saved conversation sessions
`telegram_config.json`	Telegram bot authorized users

🤝 Contributing

How to Contribute

Fork the repository
Create a feature branch: git checkout -b feature/amazing-feature
Commit changes: git commit -m 'Add amazing feature'
Push to branch: git push origin feature/amazing-feature
Open a Pull Request

Development Setup

# Clone your fork
git clone https://github.com/yourusername/ZynoxAI.git
cd ZynoxAI

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dev dependencies
pip install requests colorama python-telegram-bot black flake8

# Run tests (manual testing for now)
python zynox.py "create test.txt"

Code Style

· Follow PEP 8 guidelines · Use descriptive variable names · Add docstrings for functions · Test on Python 3.7+

Feature Ideas

· Support for local LLMs (Ollama, LM Studio) · Batch operations from file · Template system for common structures · Undo/redo functionality · GUI wrapper (Tkinter/PyQt) · VS Code extension · Support for more AI providers (Claude) · File content editing/updating · Git integration · Web interface · Docker support

📄 License

MIT License

🙏 Acknowledgments

· OpenAI for GPT models · Google for Gemini models · xAI for Grok models · DeepSeek for their excellent code generation models · python-telegram-bot for Telegram integration · Termux team for making Linux on Android possible · All contributors who help improve this tool

Name		Name	Last commit message	Last commit date
Latest commit History 37 Commits
images		images
output/examples		output/examples
src/zynox		src/zynox
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
__init__.py		__init__.py
__main__.py		__main__.py
install.sh		install.sh
requirements.txt		requirements.txt
zynox.py		zynox.py

Folders and files

Latest commit

History

Repository files navigation

🚀 ZynoxAI - AI-Powered Automation Tool

📋 Table of Contents

🤖 What is ZynoxAI?

Use Cases

✨ Features

Core Features

Technical Features

🧠 Supported AI Providers

📦 Installation

Prerequisites

Step 1: Install Dependencies

Step 2: Clone/Create ZynoxAI

Step 3: Set Up Alias (Optional but Recommended)

Step 4: Verify Installation

🔧 Configuration

🚀 Quick Start

📚 Usage Guide

💡 Examples

📖 Commands Reference

💬 Telegram Bot

1. Start the bot

🔧 Smart Installation

🧠 Memory & Sessions

🔍 Troubleshooting

1. Permission Denied Error

2. API 400 Error (DeepSeek)

3. Timeout Error

4. JSON Parse Error

5. API Key Not Working

6. Telegram Bot Not Starting

🔑 API Keys

📁 Project Structure

ZynoxAI File Descriptions

Root Directory

src/zynox/

src/zynox/utils/

src/zynox/memory/

src/zynox/core/ai_providers/

src/zynox/core/command/

src/zynox/core/file/

src/zynox/core/prompt/

src/zynox/bot/

Output Directories (auto-created)

Config Directories (auto-created at ~/.zynoxai/)

🤝 Contributing

🙏 Acknowledgments

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 7

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages