https://github.com/ntk148v/dotboss
dotboss is a easy to use dotfiles manager
https://github.com/ntk148v/dotboss
bash dotfiles dotfiles-installer dotfiles-linux dotfiles-manager stow
Last synced: 8 months ago
JSON representation
dotboss is a easy to use dotfiles manager
- Host: GitHub
- URL: https://github.com/ntk148v/dotboss
- Owner: ntk148v
- License: apache-2.0
- Created: 2020-12-11T07:14:48.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-14T03:22:54.000Z (over 4 years ago)
- Last Synced: 2025-01-01T22:12:10.331Z (9 months ago)
- Topics: bash, dotfiles, dotfiles-installer, dotfiles-linux, dotfiles-manager, stow
- Language: Shell
- Homepage:
- Size: 103 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dotboss
```
________ _____________________________ ________ _________ _________
\______ \ \_____ \__ ___/\______ \\_____ \ / _____// _____/
| | \ / | \| | | | _/ / | \ \_____ \ \_____ \
| ` \/ | \ | | | \/ | \/ \/ \
/_______ /\_______ /____| |______ /\_______ /_______ /_______ /
\/ \/ \/ \/ \/ \/
```
- [dotboss](#dotboss)
- [1. What is this?](#1-what-is-this)
- [2. Features](#2-features)
- [3. Installation](#3-installation)
- [4. Usage](#4-usage)
- [5. Explanation](#5-explanation)
- [6. Sample source dotfiles repository](#6-sample-source-dotfiles-repository)
## 1. What is this?
dotboss is a easy to use dotfiles manager.
> Inspired by [Dotman](https://www.freecodecamp.org/news/build-your-own-dotfiles-manager-from-scratch/).
## 2. Features
- Single file manager.
- No config files.
- Easy to use.
- Use stow to manage dot files.
- Automatically watch changes and backup.
## 3. Installation
- Install the dependencies.
- `stow`
- `bash >= 3`
- `git`
- `tree`
- [`gitwatch`](https://github.com/gitwatch/gitwatch)
- [`inotify-tools`](https://github.com/rvoicilas/inotify-tools)
- `dotboss` can be installed from source by simply cloning the repository and putting the shell script into your `$PATH`. The bellow commands will do that for you if `/usr/local/bin` is in your `$PATH`. You may need to involve `install` with `sudo`.
```bash
$ git clone https://github.com/ntk148v/dotboss.git
$ cd dotboss
$ bash install.sh
```
## 4. Usage
- Prepare your repository, folder structure should look like this:
```bash
$ tree
.
|-- LICENSE
|-- README.md
`-- home
1 directory, 2 files
```
- Configure your Git username & email for commits. For example:
```bash
$ git config --global user.name "FIRST_NAME LAST_NAME"
$ git config --global user.email "MY_NAME@example.com"
```
- Note that, if you use automatic mode, you have to configure remote url as SSH url. This is documented at Github: [Switching remote URLs from HTTPS to SSH](https://help.github.com/articles/changing-a-remote-s-url/#switching-remote-urls-from-https-to-ssh). Or you can configure Git to store your username & password.
```bash
# Make Git store the username and password and it will never ask for them.
$ git config --global credential.helper store
# Save the username and password for a session (cache it);
$ git config --global credential.helper cache
```
- Run `dotboss` anywhere in your terminal.
```bash
$ dotboss
Hi kiennt 👋
________ _____________________________ ________ _________ _________
\______ \ \_____ \__ ___/\______ \\_____ \ / _____// _____/
| | \ / | \| | | | _/ / | \ \_____ \ \_____ \
| | \/ | \ | | | \/ | \/ \/ \
/_______ /\_______ /____| |______ /\_______ /_______ /_______ /
\/ \/ \/ \/ \/ \/
First time use 🔥, spend time to do a dotboss setup
...................................................
NOTE: Your dotfiles folder has to contain a subfolder named home
➤ Enter dotfiles repository URL:
```
## 5. Explanation
Explain how dotboss works inside, options...
> **TODO**
## 6. Sample source dotfiles repository
You can found the sample dotfiles repository [here](https://github.com/ntk148v/dotfiles).