https://github.com/hazyuun/Chrono
A git time machine, it automatically commits in a temporary branch every time a costumizable event occurs, so that rolling-back to a specific point in time is always possible if anything goes wrong.
https://github.com/hazyuun/Chrono
backup git go golang version-control
Last synced: 7 months ago
JSON representation
A git time machine, it automatically commits in a temporary branch every time a costumizable event occurs, so that rolling-back to a specific point in time is always possible if anything goes wrong.
- Host: GitHub
- URL: https://github.com/hazyuun/Chrono
- Owner: hazyuun
- License: mit
- Created: 2022-08-20T19:01:30.000Z (about 3 years ago)
- Default Branch: dev
- Last Pushed: 2023-04-15T12:36:05.000Z (over 2 years ago)
- Last Synced: 2024-08-01T22:43:40.543Z (over 1 year ago)
- Topics: backup, git, go, golang, version-control
- Language: Go
- Homepage:
- Size: 395 KB
- Stars: 85
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
Chrono
A Git Time Machine
---
Chrono automatically commits in a temporary branch every time a costumizable event occurs.
So that you can always rollback to a specific point in time if anything goes wrong.
You can squash merge all the temporary commits into one once you are done.
---
## Disclaimer
This is still in early development stages.
If you are going to use it or test it, ***please use with caution***.
Use at your own risk, I am ***NOT*** responsible for any of your acts.
## How to install
```bash
git clone https://github.com/hazyuun/Chrono.git
cd Chrono
go install .
```
> Make sure you have `go` installed, if not, you can easily install it using your package manager
The binary will be installed into `~/go/bin/` by default, make sure it is in your `PATH` environment variable, if not, you can add it using:
```bash
export PATH="$HOME/go/bin/:$PATH"
```
> Note that this will add `~/go/bin/` to `PATH` just for the current terminal session, you can add that line to your `~/.profile` for a permanent effect.
Now you can run the following command to check if it is installed correctly:
```bash
chrono --help
```
## Workflow
### Create a chrono session
Create a new session using:
```bash
$ chrono session create session_name
```
Important: Please note that this will create a branch from the current HEAD, so make sure it is currently in the commit where you want to create the chrono session.
You can create as many sessions as you want, to list existing sessions you can run the following command:
```bash
$ chrono session list
```
### Start a Chrono session
Start a Chrono session using:
```bash
$ chrono session start session_name
```
From now on, Chrono will be automatically committing changes to the session's specific branch whenever an event occurs.
> Important: Please note that after you stop running this command, you will still be in the session branch for convinience.
Events are customizable using a `chrono.yaml` file (see [below](#config-file) for details).
---
### Merging and deleting the session
## Using chrono
When done, you can merge the Chrono branch to your original branch
```bash
$ chrono session merge session_name "Commit message"
```
Then if everything is as expected, you can delete the session:
```bash
$ chrono session delete session_name
```
---
## Manually
You can also merge manually (A squash merge is recommended) the Chrono branch to your original branch (let's call it original_branch):
```bash
$ git checkout original_branch
$ git merge --squash chrono/session_name
```
Then if everything is as expected, you can commit the merge:
```bash
$ git commit -m "Your commit message"
```
...and delete the session:
```bash
$ chrono session delete session_name
```
---
## Config file
Put a file named `chrono.yml` in the root of your repository.
Here is an example config file:
```yaml
# Events when to automatically commit
events:
# This triggers every amount of minutes
- periodic:
# Every 60 seconds
period: 60
# Commit those files
files: ["src/", "file.txt"]
# This triggers every file save
- save:
# Those files will be committed once they're saved
files: ["notes.txt"]
# Use files: ["."] if you want all files inside the current directory to be commited (Not recursively, files inside subdirectories won't be committed)
git:
# When true, untracked files will automatically be added
auto-add: true
```
If you want to exclude some files when using `files: ["."]`, just use your regular `.gitignore` file.
---
## Contributions
Pull requests and issues are welcome !