https://github.com/callmeechocodes/dossier

:rocket: A lightweight dotfile bootstrapper!
https://github.com/callmeechocodes/dossier

bash dossier dotbot dotfiles sh shell shell-script yadm

Last synced: 3 months ago
JSON representation

:rocket: A lightweight dotfile bootstrapper!

• Host: GitHub
• URL: https://github.com/callmeechocodes/dossier
• Owner: CallMeEchoCodes
• License: mpl-2.0
• Created: 2022-07-30T08:43:24.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-05T08:46:39.000Z (about 1 year ago)
• Last Synced: 2024-01-05T09:41:19.116Z (about 1 year ago)
• Topics: bash, dossier, dotbot, dotfiles, sh, shell, shell-script, yadm
• Language: Shell
• Homepage:
• Size: 48.8 KB
• Stars: 14
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Dossier

> :rocket: A lightweight dotfile bootstrapper!

![aur version](https://img.shields.io/aur/version/dossier) [![license](https://img.shields.io/github/license/CallMeEchoCodes/dossier)](https://github.com/CallMeEchoCodes/dossier/blob/master/LICENSE) [![PRs welcome](https://img.shields.io/badge/PRs-welcome-ff69b4.svg)](https://github.com/CallMeEchoCodes/dossier/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)



## 🚩 Table of Contents

- [Why Use Dossier?](#-why-use-dossier)

- [Contributing](#-contributing)

- [Used By](#-used-by)

- [License](#-license)

## 🤖 Why Use Dossier?

Dossier is a tool that symlinks your dotfiles to where they should be. Allowing you to setup a computer really fast! While other alternatives exist Dossier aims to be simpler than other alternatives with a good user experience and really fast speeds.

## :wrench: Installing

Arch linux: ` -S dossier`


Anything else: 

```sh

# Install https://github.com/charmbracelet/gum using the guide in the README.MD

git clone https://github.com/CallMeEchoCodes/dossier.git

sudo ln -s ./dossier/dossier /usr/bin/

```

## 🔧 Contributing

Dossier is open source, so you can create a pull request (PR). Simply `git clone` and your ready to go!

### Setup

Fork `main` branch into your personal repository. Clone it to local computer.

Be sure that you have [gum](https://github.com/charmbracelet/gum) as it's required for the script.

```sh

git clone https://github.com/CallMeEchoCodes/Dossier.git

```

### Develop

Fork and simply make your changes and submit a PR

### Pull Request

Before uploading your PR, test all features one last time to check if there are any errors. If it has no errors, commit and push it!

## 🚀 Used By

[Echo's Dotfiles](https://github.com/CallMeEchoCodes/dotfiles)


## 📜 License

This software is licensed under the [MPL-2.0 License](https://github.com/CallMeEchoCodes/dossier/blob/master/LICENSE).