dotfiles/README.md

2.2 KiB

My Personal Dotfiles

Personal configuration for Linux/macOS stuff. If you're working at The Pins Team, see our dotfiles.

Getting Started

Running from

# configure required variables
export GITLAB_LOGIN=ajhalili2006
export GITLAB_TOKEN=<my-gitlab1dotcom-PAT>

# Run the bootstrap script
$(command -v curl>>/dev/null && echo curl -o- || echo wget -q0-) https://raw.githubusercontent.com/ajhalili2006/dotfiles/main/bootstrap | bash -

# Done? Don't forget to cleanup as needed.
unset GITLAB_TOKEN GITLAB_LOGIN && history -c

With Cloning the Repo

# assuming git is installed
git clone https://github.com/ajhalili2006/dotfiles $HOME/.dotfiles
cd $HOME/.dotfiles

# you may need to export the required variables before running the bootstrap script locally
# you may optionally run the bootstrapper script if you want
GITLAB_LOGIN=AndreiJirohHaliliDev2006 GITLAB_TOKEN=<my-gitlab-saas-pat> ./bootstrap --flags-over here

Documentation

Available documentation for the on/offboarding processes I do + other tidbits of the bootstrap script can be accessible through the docs directory.

Want to fork me owo?

Follow the checklist below after forking to ensure no references to mine are found. Remember that your fork, your problem. It's up to you on how do you customize stuff. You can use The Pins Team's dotfiles template to start from our template.

  • Customize the dotfiles-bootstrapper-script.sh and setup.sh into your needs.
  • Delete any existing dotfiles I made (e.g. gitconfig/*, bashrc/* excluding aliases and worthwhile-functions, etc.) and do bin/backup-dotfiles. That script will move your current config into your .dotfiles local repo and do soft links.
  • Edit bin/fix-wrong-emails#L6-7 to use your email instead of mine.
  • Edit bin/add-ssh-keys#L4 to use your SSH key in ~/.ssh directory.
  • Want to backup your worst secrets AKA SSH and PGP keys (and some Pyrgoram session files?) Use my bin/init-secrets-dir script to setup an secrets directory. Don't forget to push this into an GitLab private repo.