doforme 0.1.0

A CLI tool that converts natural language to CLI commands using LLMs

DoForMe

A CLI tool that converts natural language into CLI commands using AI. No more remembering complex command syntax!

Features

• 🤖 Uses OpenAI's GPT models to understand natural language
• 🔍 Automatically checks if required tools are installed
• ⚡ Fast and easy to use
• 🔐 Secure API key management
• ✅ Confirmation before executing commands
• 🎯 Dry-run mode to preview commands

Installation

From PyPI (when published)

pip install doforme

From source

git clone https://github.com/yourusername/doforme.git
cd doforme
pip install -e .

Setup

1. Get an OpenAI API Key

Get your API key from OpenAI Platform

2. Configure the API Key

You have two options:

Option A: Environment Variable (Recommended)

export OPENAI_API_KEY=your_key_here

Add this to your ~/.bashrc or ~/.zshrc to make it permanent.

Option B: Interactive Setup

Just run doforme without an API key and it will prompt you to enter one:

doforme "list files"

Option C: Using DoForMe itself

doforme "set the api key to sk-..."

Usage

Basic Usage

Simply describe what you want to do in natural language:

doforme "downsize with ffmpeg to max 1024 on each side"

This will:

1. Query the AI to generate the appropriate command
2. Show you the command
3. Ask for confirmation
4. Execute it (if you confirm)

More Examples

# File operations
doforme "find all python files in this directory"
doforme "compress this folder into a zip file"
doforme "count lines of code in all js files"

# Media processing
doforme "convert all png images to jpg"
doforme "extract audio from video.mp4"
doforme "create a gif from images"

# System operations
doforme "show disk usage"
doforme "find the largest files in current directory"
doforme "check my internet speed"

# Git operations
doforme "show git log for the last 5 commits"
doforme "undo last commit but keep changes"

Options

Dry Run Mode

Preview the command without executing:

doforme --dry-run "delete all log files"

Auto-Execute Mode

Skip confirmation (use with caution!):

doforme --yes "show current date"
doforme -y "list files"

How It Works

1. Input: You provide a natural language description
2. AI Processing: DoForMe sends your request to OpenAI's API
3. Command Generation: The AI generates the appropriate CLI command
4. Validation: Checks if required tools are installed
5. Confirmation: Shows you the command and asks for confirmation
6. Execution: Runs the command in your shell

Safety Features

• ✅ Shows you the command before execution
• ✅ Checks if required tools exist on your system
• ✅ Secure API key storage (600 permissions)
• ✅ Confirmation prompts (can be disabled with -y)
• ✅ Dry-run mode for testing

Error Handling

If a required tool is not installed, DoForMe will tell you:

$ doforme "convert video with ffmpeg"
🤔 Thinking about: convert video with ffmpeg

📋 Command: ffmpeg -i input.mp4 output.avi

❌ Error: Required tool 'ffmpeg' is not installed on your system.
   Please install it and try again.

Configuration

API key is stored in ~/.config/doforme/config with secure permissions (600).

To change your API key:

doforme "set the api key to sk-new-key-here"

Or manually edit ~/.config/doforme/config.

Requirements

• Python 3.8 or higher
• OpenAI API key
• Internet connection (for API calls)

Privacy & Security

• Your prompts are sent to OpenAI's API
• API keys are stored locally with restricted permissions
• Commands are shown before execution
• No telemetry or tracking

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License - see LICENSE file for details

Troubleshooting

"No OpenAI API key found"

Make sure you've set the OPENAI_API_KEY environment variable or run the interactive setup.

"Required tool not installed"

Install the missing tool using your package manager:

# Ubuntu/Debian
sudo apt install <tool-name>

# macOS
brew install <tool-name>

# Fedora
sudo dnf install <tool-name>

Command doesn't work as expected

Use --dry-run to see the generated command and adjust your prompt for better results.

Acknowledgments

• Built with OpenAI API
• Inspired by the need to simplify CLI usage

Support

For issues and questions, please open an issue on GitHub.