/superb-bootstrap

๐Ÿ…ฑ๏ธ OS dotfiles-manager framework that SuperB

Primary LanguageShellGNU General Public License v3.0GPL-3.0

โš ๏ธ This project although convenient, it's too unreliable. Please use Nixpkgs instead.

OS bootstrap-system/dotfiles-manager framework that SuperB

License: GPL-3.0 Development completed

๐Ÿ’ก About

SuperB Bootstrap is a SuperB OS bootstrap-system/dotfiles-manager framework that can be installed with just one command on a new *NIX system installation.

โœจ Features

๐Ÿš€ Setup

First generate using this template, or if you want, you can setup manually:

๐Ÿ”ง Manually

If you manage your dotfiles with git, run the following commands:

mkdir -p ~/dotfiles/home ~/dotfiles/root ~/dotfiles/extra

curl -fsSL https://raw.githubusercontent.com/NNBnh/superb-bootstrap-template/main/packageslist --create-dirs --output ~/dotfiles/packageslist
curl -fsSL https://raw.githubusercontent.com/NNBnh/superb-bootstrap-template/main/setup --create-dirs --output ~/dotfiles/setup

cd ~/dotfiles

git submodule add https://github.com/NNBnh/superb-bootstrap.git ./extra/sbb
git submodule add https://github.com/NNBnh/bsymlink.git ./extra/bsymlink

if not, run the following commands:

mkdir -p ~/dotfiles/home ~/dotfiles/root ~/dotfiles/extra

curl -fsSL https://raw.githubusercontent.com/NNBnh/superb-bootstrap-template/main/packageslist --create-dirs --output ~/dotfiles/packageslist
curl -fsSL https://raw.githubusercontent.com/NNBnh/superb-bootstrap-template/main/setup --create-dirs --output ~/dotfiles/setup

curl -fsSL https://raw.githubusercontent.com/NNBnh/superb-bootstrap/master/sbb --create-dirs --output ~/dotfiles/extra/sbb/sbb
curl -fsSL https://raw.githubusercontent.com/NNBnh/bsymlink/main/bin/bsymlink --create-dirs --output ~/dotfiles/extra/bsymlink/bin/bsymlink

Note: if you don't use Git, you have to manually update SBB and Bsymlink by running the last two commands.

๐Ÿ“ File structure

The file structure will looks like this:

dotfiles/
โ”œโ”€ home/              # Symlink to home (add anything like .config/ or .local/ that you what to bootstrap here)
โ”œโ”€ root/              # Symlink to root (same with this directory but it will be symlink to '/' directory)
โ”œโ”€ extra/             # Other files that you want to backup or store but don't want to symlink
โ”‚  โ”œโ”€ sbb/...         # This contain the script file to bootstrap
โ”‚  โ””โ”€ bsymlink/...    # This contain the symlink tool
โ”œโ”€ packageslist       # Packages list
โ””โ”€ setup              # Setup script

โš™๏ธ Customization

Next, customizing your your dotfiles:

  • Move everything you want to backup in home/ and root/
  • Add packages to packageslist (see example)
  • Config the setup scripts (see example)

Remember to make setup executable:

chmod +x ~/dotfiles/setup

Finally store or upload your dotfiles to a safe place.

๐Ÿ“ฅ Installation

To install your dotfiles, put the dotfiles to the desired location then execute setup file.

For example if you store your dotfiles on Github, first download it:

git clone https://github.com/yourname/dotfiles.git

cd to dotfiles:

cd dotfiles

Then execute the setup file:

./setup

You can install your dotfiles with just one command:

git clone https://github.com/yourname/dotfiles.git && ./dotfiles/setup

๐Ÿ’Œ Credits

Special thanks to:






Made with โค๏ธ by NNB

Buy Me a Coffee