# SyncShell
<!-- License -->
<a href="https://mit-license.org/msudgh">
<img src="https://img.shields.io/badge/license-MIT-brightgreen.svg"
alt="MIT License" />
</a>
<!-- Build Status -->
<a href="https://github.com/msudgh/syncshell/actions/workflows/test.yaml">
<img src="https://github.com/msudgh/syncshell/actions/workflows/test.yaml/badge.svg?branch=main"
alt="Build Status" />
</a>
<!-- Releases -->
<a href="https://github.com/msudgh/syncshell/releases">
<img src="https://img.shields.io/github/release/msudgh/syncshell.svg"
alt="PyPi" />
</a>
<!-- PyPi -->
<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:
```bash
$ pip install syncshell
```
## Usage
To use SyncShell, It first needs to set up a Github token key by following these steps:
1. Open [**Github personal access tokens**](https://github.com/settings/tokens) page, [**Generate a new token**](https://github.com/settings/tokens/new) with `gist` scope feature.
2. 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:
```bash
$ syncshell upload
```
After uploading, the download command lets to sync and pull changes on the other machines:
```bash
$ syncshell download
```
### Synopsis
```bash
$ 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 is a tool that synchronizes shell history across all devices by securely storing the history file on Github Gist. Github Gist provides two types of Gists, `public` and `secret`. When the `syncshell upload` command is executed, the shell history file is uploaded and stored securely on Github Gist as a secret Gist. To download the uploaded shell history on other devices, the `syncshell download` command is used. This command retrieves the previously uploaded Gist, allowing the user to access their shell history on any device.
**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 usecase.
## Contributing
I would love to have your help in making SyncShell idea better and expand it capabilities.
### 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:
1. Install [poetry](https://python-poetry.org/docs/#installation) as a dependency manager
2. Install dependencies by running ```poetry shell && poetry install```
3. Make your changes
4. Run and debug your changes by running ```poetry run python syncshell```
5. Run tests by running ```poetry run pytest -c pytest.ini -s```
6. Submit a pull request
## License
The code is licensed under the MIT License. See the data's [LICENSE](https://github.com/msudgh/syncshell/blob/main/LICENSE) file for more information.
Raw data
{
"_id": null,
"home_page": "https://github.com/msudgh/syncshell",
"name": "syncshell",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0.0,>=3.8.18",
"maintainer_email": null,
"keywords": "sync, shell, history, bash, zsh",
"author": "Masoud Ghorbani",
"author_email": "masoudghorbani@pm.me",
"download_url": "https://files.pythonhosted.org/packages/1a/05/65be45b6256868a6ba17fc9d253bcaaf717d8e69f3971049c3c534218295/syncshell-1.0.8.tar.gz",
"platform": null,
"description": "# SyncShell\n<!-- License -->\n<a href=\"https://mit-license.org/msudgh\">\n <img src=\"https://img.shields.io/badge/license-MIT-brightgreen.svg\"\n alt=\"MIT License\" />\n</a>\n<!-- Build Status -->\n<a href=\"https://github.com/msudgh/syncshell/actions/workflows/test.yaml\">\n <img src=\"https://github.com/msudgh/syncshell/actions/workflows/test.yaml/badge.svg?branch=main\"\n alt=\"Build Status\" />\n</a>\n<!-- Releases -->\n<a href=\"https://github.com/msudgh/syncshell/releases\">\n <img src=\"https://img.shields.io/github/release/msudgh/syncshell.svg\"\n alt=\"PyPi\" />\n</a>\n<!-- PyPi -->\n<a href=\"https://pypi.org/project/syncshell/\">\n <img src=\"https://img.shields.io/pypi/v/syncshell.svg\"\n alt=\"PyPi\" />\n</a>\n\nSyncShell 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.\n\n## Features\n\n- Sync your shell history across all your devices\n- Securely store your shell history on Github Gist\n- Support for `zsh` and `bash` shells\n- Easy to install and use\n\n## Installation\nTo install SyncShell, simply run the following command:\n\n```bash\n$ pip install syncshell\n```\n\n## Usage\nTo use SyncShell, It first needs to set up a Github token key by following these steps:\n\n1. Open [**Github personal access tokens**](https://github.com/settings/tokens) page, [**Generate a new token**](https://github.com/settings/tokens/new) with `gist` scope feature.\n2. Execute the **`syncshell auth`** command, Enter the token key to validate and confirm it.\n\nOnce finished, try to upload shell history by the following command:\n\n```bash\n$ syncshell upload\n```\n\nAfter uploading, the download command lets to sync and pull changes on the other machines:\n\n```bash\n$ syncshell download\n```\n\n\n### Synopsis\n\n```bash\n$ syncshell\nType: Application\nString form: <syncshell.cli.Application object at 0x101b1ff10>\nDocstring: SyncShell CLI Application\n\nUsage: syncshell\n syncshell auth\n syncshell download\n syncshell upload\n```\n\n## How it Works\n\nSyncShell is a tool that synchronizes shell history across all devices by securely storing the history file on Github Gist. Github Gist provides two types of Gists, `public` and `secret`. When the `syncshell upload` command is executed, the shell history file is uploaded and stored securely on Github Gist as a secret Gist. To download the uploaded shell history on other devices, the `syncshell download` command is used. This command retrieves the previously uploaded Gist, allowing the user to access their shell history on any device.\n\n**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.\n\n**Privacy:** In case of having password or secret in a history file, Its suggested to first have a alignment with privacy policies for any usecase.\n\n## Contributing\n\nI would love to have your help in making SyncShell idea better and expand it capabilities.\n\n### Branching\n\n- `main` is being used for the latest development version.\n- `release` is being used for the latest stable version.\n\n\n### Pull Requests\nTo contribute follow the below steps:\n\n1. Install [poetry](https://python-poetry.org/docs/#installation) as a dependency manager\n2. Install dependencies by running ```poetry shell && poetry install```\n3. Make your changes\n4. Run and debug your changes by running ```poetry run python syncshell```\n5. Run tests by running ```poetry run pytest -c pytest.ini -s```\n6. Submit a pull request\n\n## License\nThe code is licensed under the MIT License. See the data's [LICENSE](https://github.com/msudgh/syncshell/blob/main/LICENSE) file for more information.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Keep your machine's shell history synchronized",
"version": "1.0.8",
"project_urls": {
"Homepage": "https://github.com/msudgh/syncshell",
"Repository": "https://github.com/msudgh/syncshell"
},
"split_keywords": [
"sync",
" shell",
" history",
" bash",
" zsh"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "76fbc11347d41e278026b277a5b4a530730e826f2f09ef98101979e3a7109fb7",
"md5": "539b0fa7c76ee50ed67017e2e6077a90",
"sha256": "bb24022c032815ef0dfb651774b2ab416d4ab9c9059168b10c6e8014d4d75471"
},
"downloads": -1,
"filename": "syncshell-1.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "539b0fa7c76ee50ed67017e2e6077a90",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0.0,>=3.8.18",
"size": 11198,
"upload_time": "2024-04-27T19:19:38",
"upload_time_iso_8601": "2024-04-27T19:19:38.117083Z",
"url": "https://files.pythonhosted.org/packages/76/fb/c11347d41e278026b277a5b4a530730e826f2f09ef98101979e3a7109fb7/syncshell-1.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1a0565be45b6256868a6ba17fc9d253bcaaf717d8e69f3971049c3c534218295",
"md5": "158001d8b897e3ea4c36450700bc10bf",
"sha256": "c8d5565323964f5afb4a318ef9d7df879d26f6855fca29cc178803b96a58bfe0"
},
"downloads": -1,
"filename": "syncshell-1.0.8.tar.gz",
"has_sig": false,
"md5_digest": "158001d8b897e3ea4c36450700bc10bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0.0,>=3.8.18",
"size": 6864,
"upload_time": "2024-04-27T19:19:40",
"upload_time_iso_8601": "2024-04-27T19:19:40.271777Z",
"url": "https://files.pythonhosted.org/packages/1a/05/65be45b6256868a6ba17fc9d253bcaaf717d8e69f3971049c3c534218295/syncshell-1.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-27 19:19:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "msudgh",
"github_project": "syncshell",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "syncshell"
}
JSON
