https://github.com/christiansilvermoon/modularized-shell-runtime-config

A Shell Runtime Configuration File that loads split components based
https://github.com/christiansilvermoon/modularized-shell-runtime-config

bash bashrc bashrc-configs bashrc-files cli configuration shell utility

Last synced: 12 days ago
JSON representation

A Shell Runtime Configuration File that loads split components based

• Host: GitHub
• URL: https://github.com/christiansilvermoon/modularized-shell-runtime-config
• Owner: ChristianSilvermoon
• License: unlicense
• Created: 2020-11-24T19:00:08.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2025-01-30T15:22:55.000Z (16 days ago)
• Last Synced: 2025-01-30T16:31:59.226Z (16 days ago)
• Topics: bash, bashrc, bashrc-configs, bashrc-files, cli, configuration, shell, utility
• Language: Shell
• Homepage: https://christiansilvermoon.github.io/Modularized-Shell-Runtime-Config/
• Size: 885 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Modularized Shell Runtime Config

A Shell Runtime Configuration File that loads split components. Partially inspired by [Quentin ADAM on medium.com's post](https://medium.com/@waxzce/use-bashrc-d-directory-instead-of-bloated-bashrc-50204d5389ff)

You should **always** review scripts from the internet before running them, the same goes for Shell Runtime Config files especially.

## Mutliple Toggle-able Configs

The main config `msrc.bashrc`, `msrc.zshrc`, etc. is meant to replace your original traditional config.

From there the script will automatically source executable files ending in `.bashrc` that it finds in: `~/.bashrc.d/`

**NOTE:** The ZSH version of MSRC is *not as well maintained* and may be missing features or functionality. This project was orignally created with BASH in mind.

## Changing Your Config Directory

This used to be based on the [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html) in earlier versions of this project, however, that was dropped in favor of using `~/.bashrc.d` and so on for simplicity and not interfering with XDG Variable usage.

If you wish to change your config directory now, you will want to use the following environment variables:

```bash

BASH_MSRC_DIR="$HOME/.bashrc.d"

ZSH_MSRC_DIR="$HOME/.zshrc.d"

```

If you do not export these your shell will do so automatically at start up, defaulting to the values shown above.

## Configuration Manager

You can manage your multiple config files quickly using the `msrc` function built into main Shell config

Try out `msrc --help` to see what all it can do!

## Extras

Some extra Shell Config files are included for convenience these may be loaded as modules using this system.

See the `shell-extras` folder for those Extras. The `README.md` within should give you some insight as to what each one does.

As a note, there is *no* strict garauntee that all of the *Extras* will be compatbile with all platforms.