https://github.com/meanii/sync.ssh
sync.ssh cli helps to keep sync your important files/dir in github.
https://github.com/meanii/sync.ssh
github golang meanii sync
Last synced: 10 months ago
JSON representation
sync.ssh cli helps to keep sync your important files/dir in github.
- Host: GitHub
- URL: https://github.com/meanii/sync.ssh
- Owner: meanii
- License: gpl-3.0
- Created: 2022-08-13T10:59:57.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-23T20:01:36.000Z (about 3 years ago)
- Last Synced: 2025-03-24T18:46:52.535Z (10 months ago)
- Topics: github, golang, meanii, sync
- Language: Go
- Homepage:
- Size: 97.7 KB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# sync.ssh
> A powerful CLI tool built in golang that helps to sync your projects (files & directories) to your personal or private
> repository!
## Installation
Requirement: go 1.19
If you have golang installed, you may run the command below to install sync. ssh
```shell
git clone https://github.com/meanii/sync.ssh.git && cd sync.ssh && bash installer.sh
```
Consequently, this command will clone the code, install it on your computer, inject all required daemon services, and
launch the programme!
## How to use it
Therefore, there are a few setups that need to be completed after installation.
- Create a private repository (public repositories are permitted but not advised).
- Obtain a github token with CRUD access.
- Now, log in to github using sync.ssh and the token you created.
```shell
sync.ssh auth --token= --username=
```
- The final step is to launch sync.ssh by using the —repo= parameter.
```shell
sync.ssh init --repo=
```
So, it's done now!
I would recommend you to check the sync.ssh's daemon service, if it's running or not
if its running, good! you can now sync dirs/files
The daemon can be manually started via `sync.ssh deamon` will sync everything, so there!
### How to sync a file and dir
It's a simpler approach; all you have to do is run the command below to sync any file.
```shell
sync.ssh sync ~/Desktop/dotfile
```
Here, `dotfile` is a dir - it's going to sync everything inside the dir
In order to sync a file
```shell
sync.ssh sync ~/.gitconfig
```
Here, `.gitconfig` is a file here, it will only sync the file!
### In order to see the list of all synced dir(s)/file(s)
`sync.ssh list`
```text
+--------------------------------------+--------------------------------------+------+--------+---------------------+
| ID | Target | Type | Status | CreatedAt |
+--------------------------------------+--------------------------------------+------+--------+---------------------+
| 8985977f-c9f9-43de-a479-8530d147434c | /home/anii/.ssh | dir | active | 15 Aug 22 09:09 IST |
| cafe8bd8-94e2-4a05-9538-d4e4f1213a46 | /home/anii/.bashrc | file | active | 15 Aug 22 09:10 IST |
| 5119586c-6b89-4f6a-a095-97d89dd3349c | /home/anii/.gitconfig | file | active | 15 Aug 22 09:10 IST |
| 4e2409f5-f146-42a1-80cd-4a4ae4887719 | /home/anii/.cobra.yaml | file | active | 15 Aug 22 13:48 IST |
| 77408c44-d821-4b34-ac2f-9339a71876d2 | /home/anii/.zshrc | file | active | 15 Aug 22 13:48 IST |
| ab1c3d0e-be63-4887-9d3f-4b21555115eb | /home/anii/.config/tabby/config.yaml | file | active | 15 Aug 22 13:51 IST |
+--------------------------------------+--------------------------------------+------+--------+---------------------+
```
---
### Copyright & License
- Copyright (C) 2022 [meanii](https://github.com/meanii )
- Licensed under the terms of
the [GNU General Public License v3.0](https://github.com/meanii/sync.ssh/blob/main/LICENSE)