clipea  by dave1010

CLI tool for generating shell commands via LLM

created 1 year ago
310 stars

Top 87.8% on sourcepulse

GitHubView on GitHub
Project Summary

Clipea is a command-line AI assistant designed to help users generate and execute shell commands quickly and efficiently. It integrates with shells like Zsh to provide a seamless experience, acting as a "Copilot for the CLI" that is faster and more cost-effective than using general-purpose chatbots.

How It Works

Clipea leverages Large Language Models (LLMs), defaulting to OpenAI's GPT-3.5, to interpret natural language requests and translate them into executable shell commands. Its key advantage lies in its deep shell integration, particularly with Zsh, where it can pre-fill the command line for immediate execution or editing. This approach minimizes context switching and leverages shell history and completion features.

Quick Start & Requirements

  • Install via pipx install clipea-cli
  • Requires Python >= 3.10.
  • Zsh shell integration is highly recommended for optimal usage (clipea alias).
  • OpenAI API key is required for default operation; configuration for other LLMs is supported.
  • Official documentation: https://github.com/dave1010/clipea

Highlighted Details

  • Seamless Zsh integration allows commands to be entered directly into the input buffer.
  • Supports GPT-4 mode by prefixing queries with "4".
  • Can process input from stdin, with a 8192-byte limit.
  • Customizable system prompts via ~/.config/clipea/system-prompt.txt.

Maintenance & Community

  • Active development with contributions from multiple individuals.
  • MIT License.

Licensing & Compatibility

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

Limitations & Caveats

Clipea's AI suggestions may occasionally be incorrect or dangerous, requiring user verification before execution. It currently lacks context memory between queries, meaning each request is handled independently.

Health Check
Last commit

2 months ago

Responsiveness

1+ week

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

Explore Similar Projects

Feedback? Help us improve.