https://github.com/igr/homer
Homer - your home dotfiles manager that works with GitHub
https://github.com/igr/homer
dotfile-manager dotfiles dotfiles-manager shell
Last synced: 8 months ago
JSON representation
Homer - your home dotfiles manager that works with GitHub
- Host: GitHub
- URL: https://github.com/igr/homer
- Owner: igr
- Created: 2017-08-16T22:49:51.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-05-24T14:34:37.000Z (about 4 years ago)
- Last Synced: 2025-03-25T00:38:10.254Z (about 1 year ago)
- Topics: dotfile-manager, dotfiles, dotfiles-manager, shell
- Language: Shell
- Homepage: http://oblac.rs/kako-cuvati-dotfiles/
- Size: 34.2 KB
- Stars: 14
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Homer v1.5.2
Your `$HOME` needs **Homer** :)
**Homer** manages your dotfiles and folders using just `git` and `GitHUb`. No symlinks, no copies.
What makes **Homer** unique is:
+ it works directly in the `$HOME`
+ it keeps track of added files, ignoring everythig else - no need to worry to ignore folders
+ _fully_ tracks all added folders - add folder and forget
+ there is no staging area (like in `git`). **Homer** hides this from user.
In other words: _pick_ files and folders from your `$HOME` and add them to the **Homer**. Everything else is ignored, which is very convenient when used in `$HOME`. **Homer** treats added files and folders differently:
+ _files_ are simply tracked when they are added. Each individual file must be manually added. Other files are ignored.
+ _folders_, however, are fully synchronized! There is no need to manually add file(s) once folder is added. **Homer** does all that for you. Of course, you can use `.gitignore` in the folders to simply ignore some files.
This makes everyday-life much easier!
## Installation :gift:
Download `homer` to your `$HOME`. Done!
## Usage
### Setup :clapper:
First you need to _initialize_ **Homer** and connect to existing GitHub repo by passing `user/repo_name`:
```shell
homer init github-user/homer-repo
```
On another machine, just _clone_ **Homer** repo from the GitHub:
```shell
homer clone github-user/homer-repo
```
Check `$HOME/.gitignore` and add some common folders. This is not necessary, but can dramatically speed up the detection of changes.
### Every-day work :sunny:
Anytime you can check the _status_; what is new, changed, deleted or untracked:
```shell
homer status
```
Start by _adding_ files and folders. When folder is added, all its files are added as well! Use `.gitgnore` to ignore files. For example:
```shell
homer add .zsh
homer add bin
...
```
If you already have some folders included in **Homer**, you can simply add all untracked files bellonging to included folders with simple:
```shell
homer add
```
You only need to add _new_ files. That is different from `git`: **Homer** does not have staging area, so you just need to add new files.
Finally, _put_ all your changes to the repo (this command will also add all untracked files from included folders):
```shell
homer put
```
On the another computer, _get_ the changes:
```shell
homer get
```
### Reset and Remove :warning:
To reset some file:
```shell
homer reset bin/text.txt
```
You can reset all changes with:
```shell
homer reset
```
To remove single file from the repo:
```shell
homer remove
```
### Update :rocket:
**Homer** can check for and download the update, if it exists:
```shell
homer update
```
This will download a new version of `homer` in your $HOME folder.
## Use with ❤
Do it!