cmd-ai

cmd-ai is an innovative natural language shell command generator and executor powered by AI. It effectively transforms plain English prompts into real, executable shell commands, integrating essential features such as safety, explanations, history tracking, and autocompletion.

Key Features

• Natural Language Processing: Users can interact with the shell using everyday language, making it more accessible and user-friendly.
• Safety Mechanisms: Built-in filters help to prevent harmful or inappropriate commands from being executed, although users are always encouraged to verify AI-generated outputs prior to use.
• Command History: Every AI-generated command is logged with a timestamp, allowing users to review and reference past commands easily.

Example Usage

Here’s a brief example demonstrating how to use the cmd-ai tool:

ai Tell me how much free space is left on the disk

This command prompts the AI to suggest a corresponding shell command, which can then be executed upon user confirmation.

Pre-defined Commands

Utilize pre-defined commands for common tasks:

ai list all running Docker containers
ai remove all .DS_Store files recursively
ai config                         # Set your OpenAI API key
ai history                        # View past commands
ai man                            # Show help
ai install-autocomplete           # Automatically set up autocomplete

Additional Functionality

Enhance the command experience with flags:

• --explain: Requests an explanation of the command before execution.
• --dry: Displays the command without executing it.
• --help or -h: Provides the help screen for usage guidance.

Shell Autocompletion

Improve productivity by generating and installing an autocompletion script:

ai install-autocomplete

This will facilitate easier command entry by suggesting completions based on user input.

Command History

Access the complete history of AI-generated commands through:

ai history

All commands are stored securely, helping users recall previous actions.

Disclaimer

While cmd-ai incorporates various safety features, users assume full responsibility for the commands executed. It is vital to review and understand generated commands to prevent unintended consequences.