Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Vaelatern/init-dotfiles
Quickly get your dotfiles up and running
https://github.com/Vaelatern/init-dotfiles
hacktoberfest
Last synced: 5 days ago
JSON representation
Quickly get your dotfiles up and running
- Host: GitHub
- URL: https://github.com/Vaelatern/init-dotfiles
- Owner: Vaelatern
- License: mit
- Created: 2015-06-07T16:34:27.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2020-10-05T01:16:34.000Z (about 4 years ago)
- Last Synced: 2024-08-02T12:50:01.345Z (3 months ago)
- Topics: hacktoberfest
- Language: Shell
- Homepage:
- Size: 30.3 KB
- Stars: 238
- Watchers: 6
- Forks: 24
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred-test - Vaelatern/init-dotfiles - Quickly get your dotfiles up and running (Shell)
- awesome-starred - Vaelatern/init-dotfiles - Quickly get your dotfiles up and running (hacktoberfest)
- jimsghstars - Vaelatern/init-dotfiles - Quickly get your dotfiles up and running (Shell)
README
Init Dotfiles
=============
**The problem:** Everybody and their grandma has a way to manage an existing
dotfiles repository. However, there is no easy way create a dotfiles repository
to start with. Even if someone uses a dotfile manager, they still need to move
files themselves, go through the manager install and configuration process, and
setup a repository under version control.
We aim to do all of this for you. All you need to do is run it, and
give it permission to do everything it does.
Currently, the script is designed for use with [Dotbot][dotbot-repo] dotfile manager and git.
Get Running in 5 Minutes
------------------------
```bash
curl -fsSLO https://raw.githubusercontent.com/Vaelatern/init-dotfiles/master/init_dotfiles.sh
chmod +x ./init_dotfiles.sh
./init_dotfiles.sh
```
Usage
--------------------
- `test` - Test mode. Nothing will actually be done. Best if you are wary
about the whole thing. Default: No.
- `verbose-config` - The Dotbot configuration will have every option
explicitly set. Default: No.
- `dump-config` - The configuration will be sent to `stdout`, perfect for
redirecting into a file. Default: No.
- `preview` - Commands will be printed to the console before being executed.
There won't be newlines between them, but you can see what they are. Default:
Yes.
- `colors` - Colorize output. Default: No.
Every command line option can have `no-` prepended to turn off the option.
For example:
```bash
./init_dotfiles.sh verbose-config no-preview
```
Will enable the `verbose-config` option and disable the `preview` option.
Contributing
------------
If you want to help out, there are two ways to do that. Either you can open an
issue, or you can fork and pull request. If you wanted a file added to your
dotfiles that isn't looked for in the script, open an issue.
[dotbot-repo]: https://github.com/anishathalye/dotbot