syncshell 1.0.5

Keep your machine's shell history synchronized.

SyncShell

Yet another tool for laziness

Keep your machine's shell history synchronized

Get SyncShell

Currently, SyncShell is just available on PyPi and by the following command install the latest version:

$ pip install syncshell # Maybe sudo need

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

Usage:       syncshell 
             syncshell auth
             syncshell download
             syncshell upload

How it Works

The actual idea of SyncShell is synchronization of your all device's shell history, it means you don't need to have concerns when you want to sync your office and home machine's shell history. Application integrated and built on top of Github Gist, and written in Python (CLI).

According to Github API, you can generate a token key with gist scope to access to Gist. Gists have two public, secret type which syncshell while executing syncshell upload command will upload your history file and store them on Github Gist securely (private).

On the others machine, by executing syncshell download after entering your token key and created Gist ID you can download the gist and sync your shell's history.

Gists will be secret until you don't share it with someone else, In other words, It'll be secret and safe until you only have the Github Token and Gist ID.

Usage

Currently, SyncShell just support zsh and supporting other shells is in WIP.

Before SyncShell can be useful you need to setup your Github token key:

1. Open Github personal access tokens page, Generate a new token with gist scope feature.
2. Execute the syncshell auth command, Enter your token key to validate and confirm it.
3. Done :wink:

Now you can try to upload your shell history by the following command:

$ syncshell upload

After the uploading process, you'll take a Gist ID that by this ID and your Github token, you can download history on the others machine by executing the following command:

$ syncshell download

Todo

• Write more test cases
• Support zsh, bash

Contributing

So nice you wanna contribute to this repository. Thank you. You may contribute in several ways consists of:

• Creating new features
• Fixing bugs

Installing dependencies

Poetry Installation is straightforward walkthough to setup a versatile package manager.

By the following command install syncshell dependencies

# Clone syncshell repository
$ git clone [e-mail]:msudgh/syncshell.git
$ cd syncshell
$ poetry install

Tests

Before submiting your PR, Execute the below command to be sure about passing test cases.

$ poetry run pytest -c pytest.ini -s

Done :wink:

License

The code is licensed under the MIT License. See the data's LICENSE file for more information.