whiz  by cloudycotton

CLI tool for terminal command generation

created 1 year ago
281 stars

Top 93.7% on sourcepulse

GitHubView on GitHub
1 Expert Loves This Project
Project Summary

Whiz is a terminal copilot that leverages OpenAI's language models to interpret natural language commands and execute them. It's designed for developers and power users seeking to streamline command-line operations by abstracting complex commands into simple, conversational prompts.

How It Works

Whiz acts as an intermediary between the user's natural language input and the terminal. It sends the user's request, along with OS platform and CPU architecture, to an OpenAI model (defaulting to gpt-3.5-turbo). The model generates a shell command, which Whiz then executes. This approach simplifies complex CLI tasks by allowing users to describe their intent rather than recalling specific syntax.

Quick Start & Requirements

  • Install via npm: npm install -g whiz_cli
  • Requires an OpenAI API key set as the OPENAI_API_KEY environment variable.
  • Optionally set WHIZ_LLM_MODEL to use different OpenAI models (e.g., gpt-4).

Highlighted Details

  • Translates natural language to shell commands.
  • Supports opening URLs and listing Git branches.
  • Customizable LLM model selection.

Maintenance & Community

  • Contributing guidelines are available in CONTRIBUTING.md.

Licensing & Compatibility

  • MIT License. Permissive for commercial use and integration with closed-source projects.

Limitations & Caveats

Whiz sends user requests and basic system information (OS, architecture) to OpenAI. Users should avoid inputting sensitive information in their commands.

Health Check
Last commit

1 year ago

Responsiveness

1 day

Pull Requests (30d)
0
Issues (30d)
0
Star History
0 stars in the last 90 days

Explore Similar Projects

Feedback? Help us improve.