Skip to content

Extras.md

Latest commit

 

History

History
129 lines (87 loc) · 9.53 KB

Extras.md

File metadata and controls

129 lines (87 loc) · 9.53 KB

install-dotfiles.rb

Basically, to get started with the dotfiles, you just need to run the ${DOTFILES_DIR}/scripts/install-dotfiles.rb script. If you have that folder in the PATH, then you don't need the fully qualified or relative location (only file name is enough to run it).

  • If you already have any of the dotfiles that are managed via this repo, DON'T WORRY! Your files will be moved to the cloned folder - so that you can then commit and push them to your fork!
  • This script will also handle nested config files - as long as they are already present in this repo.
  • Special handling (rename + copy instead of symlink) for .gitattributes and .gitignore - which means that, for those files alone, you will have to keep them manually in sync.
  • If you do not want a specific file from the home folder to be overridden, simply delete it from this repo's files folder - and it will not be processed.
  • If you wish to add a new file to be tracked and managed via this backup mechanism, simply add it into the files folder with the requisite relative path (relative to your / folder) - and it will be processed.

add-upstream-git-config.sh

This script can be used to quickly add a new upstream remote to the specified git repo. The name of the new remote is hardcoded to upstream. The rest of the url remains the same with just the username switched to the specified username.

add-upstream-git-config.sh -d <target-folder> -u <upstream-repo-owner>

capture-prefs.sh

This script is useful to capture the preferences of the known applications (both system-installed and custom-installed applications) using the defaults read command. It can be used to both export the preferences/settings (from the old system) or import them (into the new system). As of version 2.0.4, added a new shell function to help with the above called: find_and_append_prefs.

capture-raycast-configs.sh

This script is useful to capture the raycast preferences/configurations. It can be used to both export the preferences/settings (from the old system) or import them (into the new system)

export RAYCAST_SETTINGS_PASSWORD='my-password'
capture-raycast-configs.sh -e "${PERSONAL_PROFILES_DIR}/extension-backups"
capture-raycast-configs.sh -i "${PERSONAL_PROFILES_DIR}/extension-backups"

Please note:

Since this script uses applescript internally, it needs to be granted the following permissions:

  • Privacy & Security > Accessibility - need to enable/approve for your preferred terminal emulator apps.
  • Also, since this mimics keystrokes from the user, while this script is running, you should not move the mouse or type anything else using the keyboard or mouse.
  • The above manual steps have to be performed after installing Raycast and running it at least once (so one has to click through the setup wizard). Due to this reason, this script has NOT been incorporated into the fresh-install-of-osx.sh script.

cleanup-browser-profiles.sh

This script is used to cleanup browser profiles folders (delete cache, session and other files that will anyways be recreated when you restart that browser). It can be safely invoked even if that browser is running (in which case it will skip processing after printing a warning to quit that application)

osx-defaults.sh

This script is the erstwhile script to codify the macos setup. It can be used to setup some options, but it hasn't been maintained for newer versions of macos. Though the system will not get corrupted, there might be cruft introduced into the system preferences which might not be easy to identify and remove at a later point in time. Use caution and YMMV.

post-brew-install.sh

This script is a collection of commands that need to be run after brew bundle so as to setup proper command-line usage of some of the gui apps like VSCode, Rancher, etc.

recreate-repo.sh

Usually, over time, if a repo has lots of branches that were deleted or became stale, and constant rebases done - it can lead to the repo bloating in size (both on local and remote). This is especially true of the browser-profiles repo in my usage since I have a cron job setup to amend the repo with the new state files. To effectively reduce the size on the remote so that any future clone does not pull down dangling commits and other cruft, the simplest way that I have found is to recreate the remote after running the git cc command on the local.

recreate-repo.sh [-f] -d <repo-folder>

resurrect-repositories.rb

I usually reimage my laptop once every couple of months. This script is useful as a catalog of all repos that I have ever worked on, and some/most which are marked active: true in the yaml to resurrect back into the new machine/image. The yaml (described below) also allows to install the required languages and their versions in an automated manner so as to avoid having to read the README.md or the CONTRIBUTING.md file for each repo on each re-image!

This script is useful to flag existing repositories that need to be backed up; and the reverse process (ie resurrecting repo-configurations from backup) is also supported by the same script! To run it, just invoke by resurrect-repositories.rb if this folder is already setup in the PATH. This will then print the usage by default and you can follow the required parameters.

This script can also be used to generate the basic version of the below yaml (onto the console stdout). See the -g option in the usage on how to use this feature.

The config file for this script is a yaml file that is passed into this script as a parameter and the structure of this configuration file is:

- folder: "${PROJECTS_BASE_DIR}/oss/git_scripts"
  remote: https://github.com/vraravam/git_scripts
  other_remotes:
    upstream1: <upstream remote url1>
    upstream2: <upstream remote url2>
  active: true
  post_clone:
    - ln -sf "${PERSONAL_CONFIGS_DIR}/XXX.gradle.properties" ./gradle.properties
    - git-crypt unlock XXX
    - echo "java 21" > ./.tool-versions
  • folder (mandatory) specifies the target folder where the repo should reside on local machine. If the folder name starts with /, then its assumed that the path starts from the root folder; if not, then its assumed to be relative to where the script is being run from. The ruby script also supports glob expansion of ~ to ${HOME} if ~ is used. It can also handle shell env vars if they are in the format ${<env-key>}
  • remote (mandatory) specifies the remote url of the repository
  • other_remotes (optional) specifies a hash of the other remotes keyed by the name with the value of the remote url
  • active (optional; default: false) specifies whether to process this folder/repo or not on your local machine
  • post_clone (optional; default: empty array) specifies other bash commands (in sequence) to be run once the resurrection is done - for eg, symlink a '.envrc' file if one exists

run-all.sh

This script will find all git repositories within the specified FOLDER (defaults to the current directory), filtered by FILTER (defaults to empty string meaning that it will not filter anything; accepts regex) and for a minimum depth of MINDEPTH (defaults to 1) and a maximum depth of MAXDEPTH (defaults to 3); and then runs the specified commands in each of the matched git repos. This script is not limited to only running 'git' commands - it can run any shell command! Examples:

  run-all.sh git status                                      # to get the git status of all git repos
  run-all.sh git clean -fxd                                  # to clean all git repos
  run-all.sh git remote prune origin                         # to run the git remote prune command
  run-all.sh git add -p                                      # to add all modified (unstaged) files for a commit eventually
  run-all.sh find . -iname patch.txt --exec rm -rfv {} \;    # find all files with the name 'patch.txt'

You can also control the starting folder by specifying the FOLDER env var, the filter for matching either the path and/or the name of the folders to be processed using FILTER (including using regular expressions for the same!) and also simultaneously control the depth using the MINDEPTH and MAXDEPTH env vars. So, for eg, to search in multiple nested folders starting at ~/dev, you can use the following command:

  FOLDER=~/dev MINDEPTH=2 MAXDEPTH=5 FILTER="oss|zsh|omz" run-all.sh git status
  FOLDER=~/dev MINDEPTH=2 MAXDEPTH=5 run-all.sh git fetch

Note: Any unix command can be run (specific to the shell that you are currently using) or git commands. These commands are run within the context of each git repository that is matched after applying the filter logic.

setup-login-item.sh

This script was originally present as a function within the ~/.aliases file, but, since loading this became cumbersome within bash (as part of the post-installation step for specific casks), it made sense to extract it out as a standalone script. This script will be used to setup specific applications as login items in the macOS system preferences.

setup-login-item.sh -a <app-name>

software-updates-cron.sh

There are so many tools installed, and some of them require their local caches/dbs/configs/etc to be updated from time to time. Rather than remembering each tool and its invocation (for updates), this script is a single place where any new tooling is added so that I don't need to remember the incantation for each separately. Run the following command to generate and update your crontab:

recron

Back to the readme