Oye.Cli 1.0.3

Oye - AI-Powered CLI Assistant

Oye is an intelligent command-line assistant that uses Ollama and AI to help you generate and execute shell commands from natural language queries.

Features

• Natural Language Processing: Convert plain English queries into shell commands
• Cross-Platform: Works on macOS, Linux, and Windows
• Safe Execution: Validates commands and asks for confirmation before execution
• Error Handling: Automatically troubleshoots failed commands
• Ollama Integration: Uses local Ollama instance for privacy and offline operation

Prerequisites

• .NET 8.0 Runtime
• Ollama installed and running locally

Installation

Option 1: Install from NuGet (Recommended)

dotnet tool install -g Oye.Cli

Option 2: Build from Source

git clone https://github.com/yourusername/Oye.git
cd Oye
dotnet build -c Release
dotnet tool install -g --add-source ./packages Oye.Cli

Setup

After installation, run Oye for the first time:

oye

Oye will automatically:

1. Check if Ollama is installed
2. Install Ollama if needed (with permission)
3. Download required AI models
4. Set up configuration

Usage

Basic Commands

# List all Python files in current directory
oye list all python files

# Show disk usage
oye show disk usage

# Find files with specific extension
oye find files with .log extension

# Count lines in current directory
oye count lines in current directory

Configuration

Configure Oye settings:

oye --config

Help

oye --help

How It Works

1. Query Processing: Your natural language query is sent to Ollama's local AI model
2. Command Generation: The AI generates a safe, single-line shell command
3. Validation: Oye validates the command for safety
4. Confirmation: You can review and confirm before execution
5. Execution: The command runs in your shell
6. Troubleshooting: If a command fails, Oye can attempt to fix it

Supported Shells

• macOS/Linux: bash, zsh
• Windows: PowerShell

Safety Features

• Only single-line commands allowed
• No multi-line scripts or complex piping
• Dangerous commands are filtered out
• User confirmation required before execution
• Local Ollama ensures privacy

Contributing

Contributions are welcome! Please see our Contributing Guide for details.

License

MIT License - see LICENSE file for details.

Support

For issues and questions:

• GitHub Issues: https://github.com/yourusername/Oye/issues
• Contributing: See CONTRIBUTING.md