Skip to content

Kunal2007-web/KDotfiles

🚀 KDotfiles

KDotfiles is a project that simplifies the post-installation process of configuring dotfiles for various command-line programs.

GitHub GitHub release (latest SemVer) GitHub repo size GitHub last commit

This is a project aimed at making the tedious post installation process of configuring your commands and programs from dotfiles easier and faster. It uses bash as the main scripting language. It contains dotfiles for many famous and useful programs people generally use such as:

  • ZSH and Additional Scripts
  • Git
  • Vim
  • GPG
  • NPM
  • LSD: An alternative to the ls command.
  • Bat: An alternative to the cat command.
  • Lazygit: A terminal git UI.
  • Ngrok: A localhost tunneling software.
  • Amfora: A terminal gemini browser.
  • Starship: A pretty and highly configurable terminal prompt.
  • Topgrade: An program to upgrade all your programs.

more dotfiles will be added with time (and as I start to use them).

⚠️ Prerequisites

These programs should be installed before using the script:

  1. git
  2. zsh
  3. curl
  4. rsync
  5. oh my zsh

This project only works for Unix-like and Unix-based systems, Ex - Linux, MacOS, etc.

💾 Installation & Usage

Installation

Download KDotfiles .zip or .tar.gz file from releases assets.

or Clone the repository in your home directory:

  • with HTTPS:
git clone https://github.com/Kunal2007-web/KDotfiles.git
  • with SSH:
git clone [email protected]:Kunal2007-web/KDotfiles.git
  • with Github CLI
gh repo clone Kunal2007-web/KDotfiles

Usage

To install the dotfiles:

cd KDotfiles
chmod +x installdotfiles.sh
./installdotfiles.sh

🤝 Contributions

For contributing to the project, please read the Code of Conduct and Contributing Guidelines.