Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jukben/gbck
π³ Intuitive lightweight tool for an easy and seamless backup of your files into Git repository
https://github.com/jukben/gbck
Last synced: 18 days ago
JSON representation
π³ Intuitive lightweight tool for an easy and seamless backup of your files into Git repository
- Host: GitHub
- URL: https://github.com/jukben/gbck
- Owner: jukben
- License: mit
- Created: 2018-01-16T20:12:47.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-06T01:56:54.000Z (almost 2 years ago)
- Last Synced: 2024-10-12T13:26:56.076Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 1.48 MB
- Stars: 38
- Watchers: 3
- Forks: 2
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - jukben/gbck - π³ Intuitive lightweight tool for an easy and seamless backup of your files into Git repository (JavaScript)
README
Git Backup
## Table of Contents
* [Introduction](#introduction)
* [Install](#install)
* [Usage](#usage)
* [Create a new project](#create-a-new-project)
* [List available projects](#list-available-projects)
* [Back up a project](#back-up-a-project)
* [Contributing](#contributing)
* [License](#license)
## Introduction
Gbck is an intuitive lightweight tool for an easy and seamless backup of your files e.g. various [config files](https://github.com/jukben/dotfiles). It's built to be an easy and flexible as possible.
All you have to do is just to create the config file containing all files (and/or commands' stdouts) you desire to back up.
π Read [gbckβ an easy way how to back up your dotfiles](https://medium.com/@jukben/gbck-an-easy-way-how-to-back-up-your-dotfiles-2a9bf44ab622)
on Medium.com
## Install
`npm i -g gbck`
_Requirement: You need to have [Node 7.5+](https://nodejs.org/en/) and [Git](https://git-scm.com/) installed on your machine_
## Usage
```
Usage: gbck [projects]
Options:
-i, --init Create new project
-f, --force Along with -i create new project even if already exists
-l, --list List all project sorted by its latest updates
-v, --version Print version
-h, --help Show this help
--auto-commit Don't ask for commit message and use default one
```
Note: gbck stores every information under `~/.gbck`
### Create a new project
For a creation of a new project just run `gbck --init`.
You project will be saved inside `~/.gbck//`
* `config`
* `README.md`
* `.vsc` - the actual Git repository folder
If you use `--force` or `-f` option you will be able to rewrite already existing project.
Now it's time to configure it, so open a `~/.gbck//config` and go on.
> Check out this example [configuration](https://github.com/jukben/dotfiles/blob/master/.gbck/config) πͺ
`config` has to be valid JSON:
* Fields `url: string`, `readme: string`, `entities: Array` are mandatory.
* Field `syncConfig: boolean` is optional and defaults to true.
* Field `branch: string` is optional and defaults to "master".
next, `entities` has to be an array:
* If the item is type of string it has to point to file or directory if so the file or directory will by backed up.
* If the item is a type of array, the first item of that array is the final file name and the second item is the command which will be run and its stdout will be backed up into this file.
* If the item is a type of object. The `i:string` and `o:string` property are mandatory, `i` is input file / folder, `o` is output name. There could be also `options: object` property defined. Possible options are:
* `symlinks: boolean`, defaults to true
* `exclude: Array` defaults to []
* `include: Array` defaults to []
```json
{
"url": "[email protected]:jukben/dotfiles.git",
"readme": "README.md",
"syncConfig": false,
"entities": [
{
"i": "~/.config/fish",
"o": ".config/fish",
"options": {
"symlinks": false,
"exclude": ["fishd.dca90476d2cf"]
}
},
{
"i": "~/Library/Application Support/Code/User/settings.json",
"o": "vscode/settings.json"
},
"~/.tmux.conf",
"~/.gitignore",
"~/.vimrc",
["brew-cask.txt", "brew cask list"]
]
}
```
### List available projects
Run `gbck --list` to see a list of available projects even with information when where lastly updated.
### Back up a project
For back up all project just simply run `gbck`. If you want to back up particular project run e.g. `gbck dotfiles private-dotfiles`
If you run this command along with `--auto-commit` you won't be asked for a commit message. This could be good for some types of automatization.
## Contributing
Do you miss something? Open an issue, I'd like to hear more about your use case. You can also fork this repository run `yarn` and send a PR! β€οΈ
Currently, tests are missing. π₯ But you can help me to fix this!
## License
The MIT License (MIT) 2018 - Jakub BeneΕ‘