SyncShell as a simple and secure tool allows to synchronize machine's shell history across devices. It's built on top of Github Gist and written in Python (CLI). With SyncShell, you no longer have to worry about manually syncing your office and home machine's shell history and let continue where the terminal session left.
zsh
and bash
shellsTo install SyncShell, simply run the following command:
$ pip install syncshell
To use SyncShell, It first needs to set up a Github token key by following these steps:
gist
scope feature.syncshell auth
command, Enter the token key to validate and confirm it.Once finished, try to upload shell history by the following command:
$ syncshell upload
After uploading, the download command lets to sync and pull changes on the other machines:
$ syncshell download
$ syncshell
Type: Application
String form: <syncshell.cli.Application object at 0x101b1ff10>
Docstring: SyncShell CLI Application
Usage: syncshell
syncshell auth
syncshell download
syncshell upload
SyncShell syncs shell history across devices by storing it on Github Gist. It uploads the history as a secret Gist with syncshell upload
and retrieves it with syncshell download
.
Security: A Gist will be secret until it's not shared and will be secret and safe until you only have the Github Token and Gist ID.
Privacy: In case of having password or secret in a history file, Its suggested to first have a alignment with privacy policies for any use case.
Any interest of contribution is welcome. Feel free to send a PR, report a bug, or request a feature. Below are the guidelines to contribute to the project.
poetry shell && poetry install
poetry run python syncshell
main
is being used for the latest development version.release
is being used for the latest stable version.To contribute follow the below steps:
poetry shell && poetry install
poetry run python syncshell
poetry run pytest -c pytest.ini -s
The code is licensed under the MIT License. Visit LICENSE file for more information.