gsh  by atinylittleshell

Generative shell for intelligent command assistance

created 8 months ago
270 stars

Top 95.9% on sourcepulse

GitHubView on GitHub
Project Summary

A modern, POSIX-compatible shell designed for the generative AI era, gsh offers intelligent command suggestions, explanations, and agent-based execution. It targets developers and power users seeking enhanced productivity and privacy through local LLM integration, while maintaining familiarity with existing shell paradigms.

How It Works

gsh integrates Large Language Models (LLMs) to provide predictive command suggestions and explanations. It can act as an agent, executing commands on behalf of the user, with commands prefixed by '#' sent to the agent. Chat macros (e.g., #/gitdiff) and agent controls (e.g., #!new) streamline interactions. It supports both local LLMs via Ollama and remote OpenAI-compatible endpoints, prioritizing privacy with local models.

Quick Start & Requirements

  • Install via Homebrew: brew install atinylittleshell/gsh/gsh
  • Or yay -S gsh-bin on Arch Linux.
  • Requires Go for building from source (make build).
  • Windows is not supported.
  • Configuration via ~/.gshrc and ~/.gshenv.
  • Supports Starship.rs for custom prompts.
  • Official docs: https://github.com/atinylittleshell/gsh

Highlighted Details

  • POSIX-compatibility aims for seamless adoption without learning a new shell language.
  • Supports local LLMs for enhanced privacy.
  • Built-in model evaluation tool to benchmark LLM performance for command prediction.
  • Automatic self-updating capability.

Maintenance & Community

The project is in early development, with a roadmap available in ROADMAP.md. Feature suggestions are welcomed via issues.

Licensing & Compatibility

The license is not explicitly stated in the README, but the project is hosted on GitHub, implying standard open-source practices. Compatibility for commercial use or closed-source linking is not detailed.

Limitations & Caveats

This project is in early development and may contain bugs, incomplete features, and breaking changes. Windows support is not yet available. Setting gsh as the default shell is not recommended due to its early stage.

Health Check
Last commit

4 months ago

Responsiveness

1 day

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

Explore Similar Projects

Feedback? Help us improve.