Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Kunal2007-web/KDotfiles

Dotfiles repository for easier and faster configuration of programs
https://github.com/Kunal2007-web/KDotfiles

amfora bash bat dotfiles functions git gitmessage gnupg lazygit lsd ngrok npm prompt shell starship starship-prompt topgrade vim vimrc zsh

Last synced: about 1 month ago
JSON representation

Dotfiles repository for easier and faster configuration of programs

Host: GitHub
URL: https://github.com/Kunal2007-web/KDotfiles
Owner: Kunal2007-web
License: agpl-3.0
Created: 2023-04-27T11:02:26.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-06-01T17:28:00.000Z (8 months ago)
Last Synced: 2024-08-13T07:15:50.554Z (5 months ago)
Topics: amfora, bash, bat, dotfiles, functions, git, gitmessage, gnupg, lazygit, lsd, ngrok, npm, prompt, shell, starship, starship-prompt, topgrade, vim, vimrc, zsh
Language: Shell
Homepage:
Size: 23.9 MB
Stars: 4
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

jimsghstars - Kunal2007-web/KDotfiles - Dotfiles repository for easier and faster configuration of programs (Shell)

README

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

![GitHub](https://img.shields.io/github/license/Kunal2007-web/KDotfiles?color=blue&label=License&style=for-the-badge)
![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/Kunal2007-web/KDotfiles?color=g&display_name=tag&label=release&sort=semver&style=for-the-badge)
![GitHub repo size](https://img.shields.io/github/repo-size/Kunal2007-web/KDotfiles?style=for-the-badge)
![GitHub last commit](https://img.shields.io/github/last-commit/Kunal2007-web/KDotfiles?style=for-the-badge)

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](https://github.com/Kunal2007-web/KDotfiles/releases) assets.

or Clone the repository in your home directory:

* with HTTPS:

``` bash
git clone https://github.com/Kunal2007-web/KDotfiles.git
```

* with SSH:

```bash
git clone [email protected]:Kunal2007-web/KDotfiles.git
```

* with Github CLI

```bash
gh repo clone Kunal2007-web/KDotfiles
```

### Usage

To install the dotfiles:

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

## 🤝 Contributions

For contributing to the project, please read the [Code of Conduct](https://github.com/Kunal2007-web/KDotfiles/blob/main/docs/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/Kunal2007-web/KDotfiles/blob/main/docs/CONTRIBUTING.md).