Skip to content

Latest commit

 

History

History
90 lines (65 loc) · 2.84 KB

README.md

File metadata and controls

90 lines (65 loc) · 2.84 KB
Raw

BFG Shell

install splash screen

What is this?

This repository contains my personal shell settings, prompt, and other customizations.

It is intended just to be for my own personal use, but is available to you under the terms of the license agreement if you would like to use or copy this project.

Rationale

The goals of this project are to ...

  • pull my favorite features from ohmyzsh and powerlevel10k.
  • never make network requests on startup required to render first prompt
    • (prevents the classic problem of hanging omz update when you have no network connection)
  • have just the features I need, without the bloat
  • start up and deliver the prompt quickly
  • support all shells that I use frequently
  • solve configuration by
    • have some global config synced to all machines through the repo
    • be able to have some config just for that machine

Supported Shells

Supports zsh and bash.

Getting Started

Run the installation script for your shell.

# For Bash
bash <(curl -s https://raw.githubusercontent.com/BenJetson/bfg_shell/main/scripts/install.sh)
# For Zsh
zsh <(curl -s https://raw.githubusercontent.com/BenJetson/bfg_shell/main/scripts/install.sh)

Then simply follow the prompts and restart your shell when you are done.

The following optional parameters are available for the installer, which may be passed as environment variables:

  • BFG_SHELL_HOME - where you would like the installer to place or use the BFG Shell repository on disk. Defaults to ~/.bfg_shell if unset.
  • BFG_SHELL_NO_CLONE - if set, then the installer will not clone the BFG Shell repository and instead attempt to use the existing install located at BFG_SHELL_HOME.
  • BFG_SHELL_CLONE_HTTPS - if set, the installer will clone the repository using an HTTPS connection. Defaults to unset; will use SSH connection.

Updating

BFG Shell does not check for updates automatically (right now). To update your installation, run:

# For Bash or Zsh
bfg_update

Note that this will get the latest version always. This may introduce breaking changes at any time, without warning. This project is designed for my personal use, so there isn't really any versioning or release notes going on here.

The reference numbers printed by the update script are counts of commits on the current branch and are not version numbers.

Removal

If you decide you do not want to use BFG Shell anymore, an uninstallation script is provided that should reverse the effects of the installer.

Read the output of this script very carefully. It can perform destructive actions that may be irreversible.

# For Bash or Zsh
bfg_run uninstall