Dotfiles

Harsh Kapadia's dotfiles and scripts.

Installables

Dotfiles

• clang-format: .clang-format
• EditorConfig: .editorconfig
• Git: .gitconfig
• Prettier: .prettierrc
• tmux: .tmux.conf
• Vim
• Bash (aliases)

Scripts and Utilities

NOTE: Scripts and utilities are selectively installed based on the options provided by the user. Please refer to the documentation below.

• hhtop
• KVM/QEMU (Not installed by setup. Has to be run manually.)
• Prompt (PS1) customization
• Adding Git aliases to .bashrc (Not used by setup script and superseded by Bash aliases)

Packages Installed

NOTE: Packages are selectively installed based on the options provided by the user. Please refer to the documentation below.

General Packages

• curl
• gh (For GitHub auth)
• git
• htop
• man
• net-tools (For ifconfig)
• openssh-client
• openssh-server
• tmux
• tree
• vim

Vim Plugin-Specific Packages

• bear (For YouCompleteMe Vim plugin)
• build-essential (For YouCompleteMe Vim plugin)
• clang-format (For formatting C files)
• cmake (For YouCompleteMe Vim plugin)
• nodejs (For Prettier)
• npm (For Prettier)
• prettier (For Prettier)
• python3
• python3-dev (For YouCompleteMe Vim plugin)
• shellcheck
• shfmt (For formatting Shell/Bash scripts)

Setup Instructions

# Navigate to the current user's home directory
$ cd ~

# Clone the repository
$ git clone https://github.com/HarshKapadia2/dotfiles.git

# Navigate to the dotfiles repository
$ cd ~/dotfiles

# Run the setup script WITHOUT sudo permissions (the user will be requested for
# the sudo password when required)
# Read the documentation below to understand all the available options
$ ./setup

# Check if symlinked dotfiles are present
$ ls -al ~

# Help text (same as documentation below)
$ ./setup -h
# Or help text with pagination
$ ./setup -h | less -R

Documentation

$ ./setup --help

NAME
        setup - Setup Harsh Kapadia's dotfiles, and install scripts and packages

SYNOPSIS
        ./setup [--install-pkg] [--vim vimrc_type] [--ps1] [--hhtop]
                [--force-setup] [--delete] [-h|--help]

DESCRIPTION
        This utility can symlink dotfiles to the current user's home directory,
        install programs (scripts) and packages, and remove/undo the setup as much
        as possible.

        NOTE: It is required to run this script without the sudo command to install
        files in the current user's directory rather than the root user's directory
        (unless that is intended). This script will prompt the user for the sudo
        password for operations that need it.

OPTIONS
        Default behaviour
                Symlink dotfiles that arent't already present in the current user's home
                directory and source a custom aliases file in the .bashrc file. This
                behaviour holds unless modified by the options below.

                To force dotfile symlinking, use --force-setup.

                Dotfiles supported: .bash_aliases_harsh, .clang-format, .editorconfig,
                .gitconfig, .prettierrc, .tmux.conf, .vimrc ('base' type - check --vim)

        No options
                Same as 'Default behaviour' above.

        --vim vimrc_type
                Choose which type of Vim configuration file should be installed.

                The supported vimrc_type values are 'base' and 'plugins' (without
                quotes for both values), with the default value being 'base' if the
                option is not used.

                Requirement: Optional

                The 'base' value installs a barebones .vimrc file that only configures
                the editor's in-built settings and has no external dependencies in terms
                of packages or plugins.

                If the 'plugins' value is used, a .vimrc file that uses vim-plug to
                install and manage Vim plugins will be symlinked. Check the
                'vim/plugins/.vimrc' file for the plugins that will be installed. This
                file also includes all the settings from the above 'base' .vimrc file.
                Quite a lot of the plugins require external packages to function, so
                using this value will also automatically install all packages that are
                installed by --install-pkg.

                Examples:
                ./setup --vim base                  # Default value that symlinks
                                                    # vim/base/.vimrc

                ./setup --vim base --install-pkg    # Symlinks vim/base/.vimrc and
                                                    # only installs 'General packages'
                                                    # installed by --install-pkg

                ./setup --vim plugins               # Symlinks vim/plugins/.vimrc and
                                                    # installs all packages installed by
                                                    # --install-pkg

                ./setup --vim plugins --install-pkg # Same as the above command

        --install-pkg
                Install packages and Vim plugin-extras on supported OSs.

                The packages installed by this option depend on the value provided to
                the --vim option. For the value 'base' (default if option not
                mentioned), only 'General packages' (listed below) are installed. For
                the 'plugins' value, both, the 'General packages' and the 'Vim
                plugin-specific packages' (listed below), are installed.

                Requirement: Optional, but note that some Vim plugins depend on packages
                to be installed to work.

                General packages: curl, gh, git, htop, man, net-tools, openssh-client,
                openssh-server, tmux, tree, vim

                Vim plugin-specific packages: bear, build-essential, clang-format,
                cmake, nodejs, npm, prettier, python3, python3-dev, shellcheck, shfmt

                Supported OSs: Debian-based distros that support APT, like Ubuntu.

                NOTE: shfmt is available only on Ubuntu >= v22 and so the script will
                fail on Ubuntu OSs less than that version.

        --ps1
                Enable command line PS1 (prompt string/statement one) customization.

                It shows the current Git branch and some other repository tracking
                information if a Git repository exists in any particular directory on
                the current working directory path. It also adds some color to the
                prompt.

                Requirement: Optional

                NOTE:
                - These customizations are not enabled by default.
                - This will modify the .bashrc file while enabling and disabling it.
                - Use --delete to disable the customization.
                        - Downloaded files will be deleted, but the changes in the .bashrc
                        file will persist.
                - Run `source $HOME/.bashrc` after enabling and disabling to make
                changes reflect in the current terminal.

        --hhtop
                Enable a wrapper utility for htop ( https://htop.dev ).

                The utility installs htop and sets different htoprc files depending on
                the number of online CPUs and columns in the terminal. Refer to
                https://github.com/HarshKapadia2/dotfiles/tree/main/hhtop
                for detailed information.

                Requirement: Optional

                NOTE:
                - This utility is not installed by default.
                - This will modify the .bashrc file while installing and uninstalling.
                - Use --delete to uninstall the utility.
                        - htoprc files will be deleted, but the changes in the .bashrc
                        file will persist.
                - Run `source $HOME/.bashrc` after installing and uninstalling to make
                changes reflect in the current terminal.

        --force-setup
                For every dotfile in the repository, delete the corresponding
                dotfile/symlink in the current user's home directory (if it exists) and
                then symlink the dotfile in this repository in its place.

                Requirement: Optional

        --delete
                Remove all symlinks that are linked to files in this repo and delete any
                related files, like all Vim plugins mentioned in the .vimrc ('plugins'
                type) file. It will also clean the insalled programs (scripts) like
                'hhtop'. All other changes in the file will not be removed. Packages are
                not uninstalled.

                Requirement: Optional

                NOTE:
                - No other option will be executed if this option is mentioned.
                - All files that can be symlinked from this 'dotfiles' repo will be
                deleted regardless of whether they were installed by this setup or not.
                        - See 'Default behaviour' above for supported dotfiles.

        -h, --help
                Print this command usage instruction.

                Requirement: Optional

                NOTE: No other option will be executed if this option is mentioned.

AUTHOR
        Harsh Kapadia ( https://harshkapadia.me )

WWW
        https://github.com/HarshKapadia2/dotfiles

REPORTING BUGS
        Report bugs and improvements at
        https://github.com/HarshKapadia2/dotfiles/issues .

Resources

• The Missing Semester of Your CS Education: Dotfiles
• What Is "rc" and What Are "rc" Files?
• Things to keep in mind about Symbolic Links
• Solving the Dotfiles Problem (And Learning Bash)