bishop

module
v0.28.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 21, 2025 License: GPL-3.0

README

bishop

License Release Build Status

A modern, POSIX-compatible, Generative Shell — fast-paced fork of gsh.

About this fork

bishop is an actively maintained fork of the original project, gsh.

Focus areas:

  • Faster development cadence and iteration
  • Compatibility with upstream features and APIs
  • Regular contribution of improvements back to upstream

Attribution: All credit for the original project goes to the upstream author and contributors.

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

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.

Generative Suggestion

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.

Command Explanation

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.

Agent Agent Coding

Highlights:

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

Full guide: docs/AGENT.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:



Documentation

Contributing

Contributions are welcome. Please read:

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.

Directories

Path Synopsis
cmd
bish command
internal
git
rag
termfeatures
Package termfeatures provides safe, cross-platform terminal feature detection and operations for window title management.
Package termfeatures provides safe, cross-platform terminal feature detection and operations for window title management.
termtitle
Package termtitle provides dynamic terminal window title updates based on user command history using an LLM to generate contextual titles.
Package termtitle provides dynamic terminal window title updates based on user command history using an LLM to generate contextual titles.
pkg
shellinput
This file is forked from the textinput component from github.com/charmbracelet/bubbles
This file is forked from the textinput component from github.com/charmbracelet/bubbles

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL