Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wulfgarpro/history-sync
An oh-my-zsh plugin for GPG encrypted internet synchronised Zsh history, with Git.
https://github.com/wulfgarpro/history-sync
oh-my-zsh zsh zsh-history zsh-plugin
Last synced: 24 days ago
JSON representation
An oh-my-zsh plugin for GPG encrypted internet synchronised Zsh history, with Git.
- Host: GitHub
- URL: https://github.com/wulfgarpro/history-sync
- Owner: wulfgarpro
- License: mit
- Created: 2016-04-12T04:59:09.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-09-16T11:25:57.000Z (about 1 year ago)
- Last Synced: 2024-09-28T08:21:05.930Z (about 1 month ago)
- Topics: oh-my-zsh, zsh, zsh-history, zsh-plugin
- Language: Shell
- Homepage: https://www.wulfgar.pro/synchronising-zsh-history-over-the-internet-with-oh-my-zsh-and-history-sync/
- Size: 3.18 MB
- Stars: 243
- Watchers: 10
- Forks: 25
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: history-sync.plugin.zsh
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/wulfgarpro/history-sync/actions/workflows/actions.yml)
# history-sync
> An Oh My Zsh plugin for GPG encrypted, Internet synchronized Zsh history using Git.
## Installation
```bash
sudo apt install gpg git
git clone [email protected]:wulfgarpro/history-sync.git
cp -r history-sync ~/.oh-my-zsh/plugins
```
Then open .zshrc file and append history-sync to the plugin line:
```bash
plugins=(... history-sync)
```
And finally, reload zsh:
```bash
zsh
```
## Usage
Before history-sync can be useful, you need two things:
1. A hosted git repository, e.g. GitHub, Bitbucket
* Ideally with ssh key access
2. A configured gpg key pair for encrypting and decrypting your history file and the enrolled public keys of all the nodes in your web of trust
* See [the GnuPG documentation](https://www.gnupg.org/documentation/) for more information since it's outside the scope of this README
Once you have these things in place, it's just a matter of updating the needed environment variables to suit your configuration:
* ZSH_HISTORY_FILE: your zsh_history file location
* ZSH_HISTORY_PROJ: your git project for housing your zsh_history file
* ZSH_HISTORY_FILE_ENC: your encrypted zsh_history file location
* ZSH_HISTORY_COMMIT_MSG: your default message when pushing to $ZSH_HISTORY_PROJ
Which have the following defaults:
```bash
ZSH_HISTORY_FILE_NAME=".zsh_history"
ZSH_HISTORY_FILE="${HOME}/${ZSH_HISTORY_FILE_NAME}"
ZSH_HISTORY_PROJ="${HOME}/.zsh_history_proj"
ZSH_HISTORY_FILE_ENC_NAME="zsh_history"
ZSH_HISTORY_FILE_ENC="${ZSH_HISTORY_PROJ}/${ZSH_HISTORY_FILE_ENC_NAME}"
ZSH_HISTORY_COMMIT_MSG="latest $(date)"
```
and running the commands:
```bash
# pull history
zhpl
# push history
zhps -r "John Brown" -r 876T3F78 -r ...
# pull and push history
zhsync
```
## Demo
Check out the [screen cast](https://asciinema.org/a/43575).
## Licence
MIT @ [James Fraser](https://www.wulfgar.pro)