heyCLI_client  by HeyCLI

CLI tool for natural language command line terminal interaction

created 2 years ago
289 stars

Top 92.1% on sourcepulse

GitHubView on GitHub
Project Summary

HeyCLI is an LLM-powered command-line interface that translates natural language queries into executable shell commands, targeting developers and power users who want to reduce time spent searching for commands or debugging errors. It aims to make terminal usage more accessible and efficient by leveraging AI for command generation and error analysis.

How It Works

The tool utilizes OpenAI's GPT-3 (davinci-003) model to interpret natural language prompts and generate corresponding shell commands. It can also analyze command errors and suggest fixes. An optional context setup feature allows users to upload their command history for more personalized and accurate suggestions.

Quick Start & Requirements

  • Install by downloading and sourcing the heycli_client.sh script from the repository.
  • Requires an API token from signup.heycli.com.
  • Set the HEỲCLI_API_KEY environment variable.
  • Supports Linux and macOS.
  • Optional: Update heycli_client.sh for enhanced debugging features.

Highlighted Details

  • Natural language to shell command translation.
  • In-terminal debugging for common command-line tools (Python, Node.js, kubectl, gcloud, aws).
  • Optional context setup using command history for improved suggestions.

Maintenance & Community

Licensing & Compatibility

  • Licensed under a permissive open-source license, similar to MIT.
  • "THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND..." clause indicates no liability for the authors.

Limitations & Caveats

The tool relies on OpenAI's GPT-3, which may incur costs. Command history upload for context setup is mentioned as potentially including sensitive data, with anonymization planned for the future.

Health Check
Last commit

2 years ago

Responsiveness

1 day

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

Explore Similar Projects

Feedback? Help us improve.