bishop

bishop

A modern, POSIX-compatible, Generative Shell.

📚 View Full Documentation

Quick start

For installation, building from source, and first run, see:

• docs/GETTING_STARTED.md

Example build from source:

git clone https://github.com/robottwo/bishop.git
cd bishop
make build
./bin/bish

Installation

Choose the package option that matches your environment. If you are unsure, the release tarballs work on most Linux systems.

Homebrew (macOS/Linux)

brew tap robottwo/bishop
brew install bish

NixOS / Nix (flakes)

nix profile install github:robottwo/bishop
# or run without installing
nix run github:robottwo/bishop

Ubuntu (release tarball)

curl -LO https://github.com/robottwo/bishop/releases/latest/download/bish_Linux_x86_64.tar.gz
tar -xzf bish_Linux_x86_64.tar.gz
sudo install -m 0755 bish /usr/local/bin/bish

Fedora (release tarball)

curl -LO https://github.com/robottwo/bishop/releases/latest/download/bish_Linux_x86_64.tar.gz
tar -xzf bish_Linux_x86_64.tar.gz
sudo install -m 0755 bish /usr/local/bin/bish

Conda (build from source inside an env)

conda create -n bishop -c conda-forge go make
conda activate bishop
git clone https://github.com/robottwo/bishop.git
cd bishop
make build
sudo install -m 0755 bin/bish /usr/local/bin/bish

Note: For ARM or other architectures, replace bish_Linux_x86_64.tar.gz with the matching release asset.

Key features

Overview

• POSIX-compatible shell with AI enhancements
• Generative assistance that predicts and explains commands
• Agent capabilities with permission controls
• Specialized AI assistants via Subagents
• Works with local or remote LLMs
• Built-in model evaluation using your command history

Generative Command Suggestion

Bishop automatically suggests the next command you are likely to run based on your history and context.

Key points:

• Suggestions are lightweight and fast
• Privacy-aware when using local models
• You stay in control: suggestions are previews until you accept

Command Explanation

Bishop can explain the command you are about to run so you can validate effects and options quickly.

Benefits:

• Prevents mistakes
• Speeds up learning of unfamiliar flags or tools
• Aids in review before execution

Agent

The Agent can perform tasks for you by executing commands with your approval, previewing file edits, and providing rich summaries.

Highlights:

• Interactive permission workflow with granular controls
• Preview of code edits and diffs before applying changes
• Chat macros for common tasks

Full guide: AGENTS.md

Subagents

Specialized assistants focused on particular tasks, tools, or workflows. Subagents improve security and quality by scoping capabilities and expertise.

Capabilities:

• Directory-aware discovery and auto-reload on cd
• Supports Claude-style and Roo Code-style configurations
• Intelligent auto-selection based on your prompt

See: docs/SUBAGENTS.md

Details and screenshots:

• docs/FEATURES.md

Documentation

• Getting started: docs/GETTING_STARTED.md
• Configuration: docs/CONFIGURATION.md
• Features: docs/FEATURES.md
• Agent: AGENTS.md
• Subagents: docs/SUBAGENTS.md
• Roadmap: ROADMAP.md
• Changelog: CHANGELOG.md

Contributing

Contributions are welcome. Please read:

• CONTRIBUTING.md

Contribution flow:

• Open issues and pull requests against this repository
• Maintainers periodically propose relevant changes upstream to keep work aligned
• Keep changes focused and upstream-friendly where possible

Status

This project is under active development. Expect rapid iteration and occasional breaking changes. Feedback and PRs are appreciated.

Acknowledgements

Built on top of fantastic open-source projects, including but not limited to:

• mvdan/sh
• charmbracelet/bubbletea
• uber-go/zap
• go-gorm/gorm
• sashabaranov/go-openai

See CHANGELOG.md for recent updates and ROADMAP.md for planned work.

License

GPLv3 License. See LICENSE.