{"id":21175538,"url":"https://github.com/capcom6/sftp-sync","last_synced_at":"2025-03-14T18:22:46.898Z","repository":{"id":195361826,"uuid":"684672267","full_name":"capcom6/sftp-sync","owner":"capcom6","description":"Command-line utility for syncing a local folder with a remote server on every change of files or directories.","archived":false,"fork":false,"pushed_at":"2024-04-10T13:42:51.000Z","size":38,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-21T11:28:16.268Z","etag":null,"topics":["ftp","real-time","sync"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/capcom6.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-08-29T16:09:59.000Z","updated_at":"2024-12-07T07:22:33.000Z","dependencies_parsed_at":"2023-11-20T03:28:32.421Z","dependency_job_id":"3b1faa46-8e1d-4544-84ed-ab7cbca24397","html_url":"https://github.com/capcom6/sftp-sync","commit_stats":null,"previous_names":["capcom6/sftp-sync"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capcom6%2Fsftp-sync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capcom6%2Fsftp-sync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capcom6%2Fsftp-sync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/capcom6%2Fsftp-sync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/capcom6","download_url":"https://codeload.github.com/capcom6/sftp-sync/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243624090,"owners_count":20321029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ftp","real-time","sync"],"created_at":"2024-11-20T16:59:49.796Z","updated_at":"2025-03-14T18:22:46.878Z","avatar_url":"https://github.com/capcom6.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sftp-sync\n\nsftp-sync is a command-line utility for syncing a local folder with a remote FTP server on every change of files or directories.\n\n## Table of contents\n\n- [sftp-sync](#sftp-sync)\n  - [Table of contents](#table-of-contents)\n  - [Features](#features)\n  - [Installation](#installation)\n  - [Usage](#usage)\n    - [Options](#options)\n    - [Arguments](#arguments)\n  - [Roadmap](#roadmap)\n  - [Contributing](#contributing)\n  - [License](#license)\n\n\n## Features\n\n- Continuous synchronization: Automatically syncs local changes to the remote FTP server whenever files or directories are added, modified, or deleted.\n- Exclude paths: Allows you to exclude specific paths from being synced.\n- Easy to use: Simple and intuitive command-line interface.\n\n## Installation\n\nYou can download the pre-built binary for your operating system from the [Releases](https://github.com/capcom6/sftp-sync/releases) section of the GitHub repository.\n\nIf you prefer to build from source, make sure you have Go installed. If not, you can download it from the official Go website: https://golang.org/dl/\n\nThen, follow these steps:\n\n1. Clone the sftp-sync repository:\n    ```shell\n    git clone https://github.com/capcom6/sftp-sync.git\n    ```\n\n2. Build the sftp-sync binary using the following command:\n    ```shell\n    cd sftp-sync\n    go build -o sftp-sync .\n    ```\n\n3. The binary will be generated in the current directory. You can move it to a location in your PATH for easy access.\n\n\n## Usage\n\nRun the `sftp-sync` command followed by the necessary options and arguments:\n\n```shell\nsftp-sync --dest=ftp://username:password@hostname:port/path/to/remote/folder --exclude=.git /path/to/local/folder\n```\n\n### Options\n\n- `--dest`: The destination FTP server URL. It should follow the format `ftp://username:password@hostname:port/path/to/remote/folder`.\n- `--exclude`: (Optional) Specifies paths or patterns to exclude from the synchronization process. You can specify multiple `--exclude` options to exclude multiple paths or patterns.\n- `--debug`: Enable debug mode.\n\n### Arguments\n\n- The local folder path: The path to the local folder you want to sync with the remote FTP server.\n\n## Roadmap\n\nHere are some ideas and suggestions for future releases:\n\n- [ ] Support for patterns in the `--exclude` option.\n- [ ] Support of Secure FTP (SFTP) protocol.\n- [ ] Improved error handling and error messages.\n- [ ] Integration with Git for automatic syncing on commit or branch changes.\n- [ ] Integration with Git for linking branch to remote server.\n- [ ] Support for other remote protocols such as S3.\n- [ ] Support for syncing specific file types or file name patterns.\n- [ ] Preserve attributes (if available).\n- [ ] Parallel sync in multiple threads.\n- [ ] Batching events for more effective sync on frequently changes.\n\nFeel free to open an issue or submit a pull request if you have any other ideas or suggestions!\n\n## Contributing\n\nContributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request on the GitHub repository.\n\n## License\n\nThis project is licensed under the [Apache License 2.0](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapcom6%2Fsftp-sync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcapcom6%2Fsftp-sync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapcom6%2Fsftp-sync/lists"}