Awesome

SyncShell

<a href="https://mit-license.org/msudgh"> <img src="https://img.shields.io/badge/license-MIT-brightgreen.svg" alt="MIT License" /> </a>  <a href="https://github.com/msudgh/syncshell/actions/workflows/tests.yaml"> <img src="https://github.com/msudgh/syncshell/actions/workflows/tests.yaml/badge.svg?branch=main" alt="Build Status" /> </a>  <a href="https://github.com/msudgh/syncshell/releases"> <img src="https://img.shields.io/github/release/msudgh/syncshell.svg" alt="PyPi" /> </a>  <a href="https://pypi.org/project/syncshell/"> <img src="https://img.shields.io/pypi/v/syncshell.svg" alt="PyPi" /> </a>

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.

Features

Sync your shell history across all your devices
Securely store your shell history on Github Gist
Support for zsh and bash shells
Easy to install and use

Installation

To install SyncShell, simply run the following command:

$ pip install syncshell

Usage

To use SyncShell, It first needs to set up a Github token key by following these steps:

Open Github personal access tokens page, Generate a new token with gist scope feature.
Execute the 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

Synopsis

$ syncshell
Type:        Application
String form: <syncshell.cli.Application object at 0x101b1ff10>
Docstring:   SyncShell CLI Application

Usage:       syncshell
             syncshell auth
             syncshell download
             syncshell upload

How it Works

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.

Contributing

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.

Development

Python 3.6+ is required.
Install poetry as a dependency manager.
Install dependencies by running poetry shell && poetry install
Run and debug your changes by running poetry run python syncshell

Branching

main is being used for the latest development version.
release is being used for the latest stable version.

Pull Requests

To contribute follow the below steps:

Install poetry as a dependency manager
Install dependencies by running poetry shell && poetry install
Make your changes
Run and debug your changes by running poetry run python syncshell
Run tests by running poetry run pytest -c pytest.ini -s
Submit a pull request

License

The code is licensed under the MIT License. Visit LICENSE file for more information.