gsh

A Modern, POSIX-compatible, Generative Shell.

Status

This project is in early development stage. Use at your own risk! Please expect bugs, incomplete features and breaking changes.

That said, if you can try it out and provide feedback, that would help make gsh more useful!

Goals

• POSIX-compatibility: you shouldn't need to learn a new shell language to adopt gsh
• Embrace AI: gsh is designed from the ground up for the generative AI era to provide you with intelligent assistance at the right place, right time
• Privacy: gsh should allow you to use local LLMs for guaranteed privacy
• Customizability: gsh is your shell. You should be able to configure it to your liking
• Extensibility: gsh should allow the community to build and share extensions to make it more useful

But what does being "generative" mean?

Generative suggestion of shell commands

gsh will automatically suggest the next command you are likely want to run.

Command explanation

gsh will provide an explanation of the command you are about to run.

Agent

gsh can act as an agent that invoke commands on your behalf. Commands starting with "#" are sent to the agent as a chat message.

gsh can even code for you!

Chat Macros

You can use chat macros to quickly send frequently used messages to the agent.

A chat macro starts with "#/" followed by the macro name. The default configuration comes with a few chat macros:

# Summarize git changes
gsh> #/gitdiff

# Commit and push changes
gsh> #/gitpush

# Review changes and get suggestions
gsh> #/gitreview

You can customize your own macros by modifying the GSH_AGENT_MACROS configuration in your .gshrc file. The value should be a JSON object mapping macro names to their corresponding chat messages. See Configuration for more details.

Agent Controls

Agent controls are built-in commands that help you manage your interaction with the agent. An agent control starts with "#!" followed by the control name.

Currently supported controls:

# Reset the current chat session and start fresh
gsh> #!new

# Show token usage statistics for the current chat session
gsh> #!tokens

Supports both local and remote LLMs

gsh can run with either

• Local LLMs through Ollama
• Or remote LLMs through an OpenAI API-compatible endpoint, such as OpenRouter

Installation

To install gsh:

# Linux and macOS through Homebrew
brew tap atinylittleshell/gsh https://github.com/atinylittleshell/gsh
brew install atinylittleshell/gsh/gsh

# You can use gsh on arch, btw
yay -S gsh-bin

Windows is not supported (yet).

Upgrading

gsh can automatically detect newer versions and self update.

Building from Source

To build gsh from source, ensure you have Go installed and run the following command:

make build

This will compile the project and place the binary in the ./bin directory.

Configuration

gsh can be configured through a configuration file located at ~/.gshrc. Configuration options and default values can be found in .gshrc.default.

gsh also loads a ~/.gshenv file, right after loading ~/.gshrc. This file can be used to set environment variables that the gsh session will use.

When launched as a login shell (gsh -l), gsh will also load /etc/profile and ~/.gsh_profile at start (before ~/.gshrc).

Custom command prompt

You can use Starship.rs to render a custom command line prompt. See .gshrc.starship for an example configuration.

Usage

Manually

You can manually start gsh from an existing shell:

gsh

Automatically, through an existing shell

You can also automatically launch gsh from another shell's configuration file:

# For bash
echo "gsh" | tee -a ~/.bashrc

# For zsh
echo "gsh" | tee -a ~/.zshrc

# Your zsh config may have set "gsh" as an alias for `git show`.
# In that case, you would need to use the full path to gsh.
echo "/full/path/to/gsh" | tee -a ~/.zshrc

Automatically, as your default shell

Or, you can set gsh as your default shell. This is not recommended at the moment as gsh is still in early development. But if you know what you are doing, you can do so by:

# Get the absolute path to gsh by running `which gsh`
which gsh

# Add gsh to the list of approved shells
echo "/path/to/gsh" | sudo tee -a /etc/shells

# Change your default shell to gsh
chsh -s "/path/to/gsh"

Default Key Bindings

gsh provides a set of default key bindings for navigating and editing text input. These key bindings are designed to be familiar to users of traditional shells and text editors. It's on the roadmap to allow users to customize these key bindings.

• Character Forward: Right Arrow, Ctrl+F
• Character Backward: Left Arrow, Ctrl+B
• Word Forward: Alt+Right Arrow, Ctrl+Right Arrow, Alt+F
• Word Backward: Alt+Left Arrow, Ctrl+Left Arrow, Alt+B
• Delete Word Backward: Alt+Backspace, Ctrl+W
• Delete Word Forward: Alt+Delete, Alt+D
• Delete After Cursor: Ctrl+K
• Delete Before Cursor: Ctrl+U
• Delete Character Backward: Backspace, Ctrl+H
• Delete Character Forward: Delete, Ctrl+D
• Line Start: Home, Ctrl+A
• Line End: End, Ctrl+E
• Paste: Ctrl+V

Roadmap

See ROADMAP.md for what's already planned. Feel free to suggest new features by opening an issue!

Acknowledgements

gsh is built on top of many great open source projects. Most notably:

• mvdan/sh - A shell parser, formatter, and interpreter
• bubbletea - A powerful little TUI framework
• zap - Blazing fast, structured, leveled logging in Go
• gorm - The fantastic ORM library for Golang
• go-openai - A Go client for the OpenAI API

Support This Project