BashSenpai is a command-line tool that utilizes the power of ChatGPT, bringing it straight to your terminal. You can ask questions and receive insightful responses related to shell scripting, making it an indispensable asset for both beginners and seasoned users alike.
- Powered by ChatGPT.
- Refined prompts employing a multi-step self-reflection process for the most optimal results.
- Receive answers executable directly in the terminal, complemented with instructive comments.
- Ask follow-up questions without providing any context; our API will include your log history.
- Menu prompt after each response, enabling you to run any provided commands, or modify if needed.
- Share optional information about the OS you are using to enhance the responses for general queries.
- Nicely formatted answers with customizable colors for improved readability.
- Modify the persona of BashSenpai, adding a touch of fun and personality to your interactions.
We ensure up-to-date packages for the following Operating Systems and Linux distributions:
Install from PPA:
sudo add-apt-repository ppa:bashsenpai/cli
sudo apt update
sudo apt install senpai-cliSupported distributions: Ubuntu 22.04 LTS or later, Linux Mint 21 or later, Pop!_OS 22.04, KDE neon 5.27, elementary OS 7.
Install from Copr:
sudo dnf copr enable bashsenpai/cli
sudo dnf install senpai-cliSupported distributions: Fedora 38, RHEL 9, CentOS Stream 9.
Install from the AUR:
yay -S senpai-cliSupported distributions: any Arch-based rolling-release distribution that supports installing packages from the AUR. Manjaro should also work, but it's untested.
Install from OBS:
sudo zypper addrepo https://download.opensuse.org/repositories/home:bashsenpai/openSUSE_Tumbleweed/home:bashsenpai.repo
sudo zypper refresh
sudo zypper install senpai-cliInstall with Homebrew:
brew tap BashSenpai/core
brew install senpai-cliDownload: Installer.
To use BashSenpai, run the following command:
senpai [options] promptThe prompt argument represents the question you want to ask or a special command you wish to execute. BashSenpai sends the prompt to the BashSenpai API and displays the response in your terminal.
- Login to BashSenpai:
senpai loginThis prompt asks you to enter an authentication token, storing it in the configuration file.
- Change the persona of BashSenpai:
senpai become angry pirateThis prompt alters BashSenpai's persona to an angry pirate, infusing a fun twist into the responses. You are not confined to a specific list of characters and can input anything you desire. Our ingeniously designed backend API, equipped with multi-level prompts and instructions, ensures all eccentric ideas are nicely integrated with the core functionality of the tool.
- Ask a question:
senpai how to disable SSH connectionsThis prompt sends the question to the BashSenpai API and displays an informative and well-formatted response.
- Ask for a command explanation:
senpai explain tarThis prompt sends a question about a specific command to the BashSenpai API and displays a list of most common use cases along with informative comments and remarks of what each one does.
-
--command-color: sets the color of the commands in the responses. Valid options are: black, white, gray, red, green, yellow, blue, magenta and cyan. Brighter versions of each color are available, for example: "bright blue". You can also bold colors, for example: "bold red" or "bold bright cyan". -
--comment-color: sets the color of the comments in the responses. -
--meta,--no-meta: determines whether to send OS metadata to refine the responses. This includes OS type and version (all OSes), shell type (macOS and Linux), and architecture (macOS). Users may choose to disable this feature for privacy reasons, or in cases where it yields undesired results (for example if the tool is operating on a Windows machine, but the user expects answers about Linux). -
-n, --new: excludes any preceding history when asking a question. Use this option to initiate a new context. -
--run,--no-run: controls whether to display the menu prompt to execute each returned command. -
-v,--version: shows current version number.
Check our Roadmap section for new and upcoming features as we develop the configuration options. We are committed to making BashSenpai user-friendly, flexible, and easily-configurable, and we value your initial feedback. If you have any suggestions or feature requests, don't hesitate to use the appropriate tools provided by GitHub to share your ideas with us.
We warmly welcome contributions to enrich and advance the BashSenpai tool. If you have any interesting ideas, bug reports, or feature requests, please create an issue on the GitHub repository. Feel free to fork the repository, make changes, and submit pull requests.
To contribute to BashSenpai, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes, ensuring they do not disrupt the core functionality of the tool.
- Commit your changes and push them to your forked repository.
- Submit a pull request, providing a clear explanation of the changes you've made.
We appreciate your interest in BashSenpai and will do our best to review any pull requests promptly and maintain an open discussion of our feature goals to facilitate a smooth and easy contribution process for everyone involved.
This project is licensed under the Apache 2.0 License. For more information, see the LICENSE file.
- Print current user configuration
- Text-only mode
- Provide instructions of how to update when a new version is available (based on OS)
- Generate docker compose configuration files
- Generate common examples for a specific command
- Better error handling: print better output on receiving an error from the API
- Additional context: provide optional information about your own environment to improve the results
- Improve the formatting of the output of the CLI
- Check if a new version is available
- MacOS build: proper MacOS integration
- Windows build: native build script with an installer
- Command execution: execute any provided list of commands directly in the terminal
- Configurable color schemes: change the default colors so they fit better with your terminal configuration
- Multi-language support: delivered by ChatGPT
- Alpine Linux packages
- openSUSE packages
- BSD-based distros packages
- Windows code-signing
This project is maintained by:
We welcome contributions from the community. If you have any queries, suggestions, or bug reports, please feel free to connect with any of the maintainers.