dotboss

________   _____________________________ ________    _________ _________
\______ \  \_____  \__    ___/\______   \\_____  \  /   _____//   _____/
 |    |  \  /   |   \|    |    |    |  _/ /   |   \ \_____  \ \_____  \
 |    `   \/    |    \    |    |    |   \/    |    \/        \/        \
/_______  /\_______  /____|    |______  /\_______  /_______  /_______  /
        \/         \/                 \/         \/        \/        \/

• dotboss
  • 1. What is this?
  • 2. Features
  • 3. Installation
  • 4. Usage
  • 5. Explanation
  • 6. Sample source dotfiles repository

1. What is this?

dotboss is a easy to use dotfiles manager.

Inspired by Dotman.

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
  • 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.

$ git clone https://github.com/ntk148v/dotboss.git
$ cd dotboss
$ bash install.sh

4. Usage

• Prepare your repository, folder structure should look like this:

$ tree
.
|-- LICENSE
|-- README.md
`-- home

1 directory, 2 files

• Configure your Git username & email for commits. For example:

$ git config --global user.name "FIRST_NAME LAST_NAME"
$ git config --global user.email "[email protected]"

• 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. Or you can configure Git to store your username & password.

# 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.

$ 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.