{"id":30729385,"url":"https://github.com/younesaassila/robosync","last_synced_at":"2025-09-03T15:08:23.164Z","repository":{"id":309355382,"uuid":"1033173215","full_name":"younesaassila/robosync","owner":"younesaassila","description":"A wrapper around Robocopy that provides a simple CLI for mirroring user directories.","archived":false,"fork":false,"pushed_at":"2025-08-06T12:15:03.000Z","size":23,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-30T04:38:59.282Z","etag":null,"topics":["python","python-poetry","typer-cli"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/younesaassila.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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-08-06T12:07:32.000Z","updated_at":"2025-08-06T12:12:29.000Z","dependencies_parsed_at":"2025-08-11T13:06:16.473Z","dependency_job_id":null,"html_url":"https://github.com/younesaassila/robosync","commit_stats":null,"previous_names":["younesaassila/robosync"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/younesaassila/robosync","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/younesaassila%2Frobosync","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/younesaassila%2Frobosync/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/younesaassila%2Frobosync/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/younesaassila%2Frobosync/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/younesaassila","download_url":"https://codeload.github.com/younesaassila/robosync/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/younesaassila%2Frobosync/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273460940,"owners_count":25109831,"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","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["python","python-poetry","typer-cli"],"created_at":"2025-09-03T15:08:16.517Z","updated_at":"2025-09-03T15:08:23.146Z","avatar_url":"https://github.com/younesaassila.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Robosync\n\nRobosync is a wrapper around Robocopy that provides a simple command-line interface for mirroring user directories.\n\nRobosync is designed exclusively for Windows systems.\n\n## Installation\n\n1. Navigate to the [Releases page](https://github.com/younesaassila/robosync/releases/latest) and download the latest `robosync.exe`.\n1. Move `robosync.exe` into a folder on your system `PATH`, or note its full location for direct invocation.\n\n## Usage\n\nTo mirror the standard user profile folders (Desktop, Documents, Downloads, Music, Pictures, Videos) to an external drive, run:\n\n```powershell\nrobosync.exe \"E:\\\"\n```\n\n### Custom Sources\n\nTo back up a custom set of directories, supply one or more `--source` flags:\n\n```powershell\nrobosync.exe \"E:\\\" \\\n  --source \"C:\\Users\\You\\Desktop\" \\\n  --source \"C:\\Users\\You\\Documents\"\n```\n\n### Namespace Configuration\n\nBy default, Robosync creates a subfolder named after your computer’s name. To override this:\n\n- Specify a custom namespace:\n\n  ```powershell\n  robosync.exe \"E:\\\" --namespace \"MyBackup\"\n  ```\n\n- Copy files directly into the root of the destination by setting an empty namespace:\n\n  ```powershell\n  robosync.exe \"E:\\\" --namespace \"\"\n  ```\n\n### Help and Options\n\nFor a full list of available flags and detailed descriptions, invoke the built‑in help:\n\n```powershell\nrobosync.exe --help\n```\n\n## Development\n\n### Prerequisites\n\n- [Python](https://www.python.org/) 3.12 or later\n- [Poetry](https://python-poetry.org/) 2.0.0 or later\n- [poetry-pyinstaller-plugin](https://github.com/thmahe/poetry-pyinstaller-plugin) 1.3.0 or later\n\n### Setup\n\n1. Clone the repository:\n\n```powershell\ngit clone https://github.com/younesaassila/robosync.git\ncd robosync\n```\n\n2. Install runtime and development dependencies:\n\n```powershell\npoetry install --with dev\n```\n\n### Running Locally\n\nExecute the application via Poetry:\n\n```powershell\npoetry run robosync [OPTIONS] DESTINATION\n```\n\n\u003e **Note:** Robocopy may require elevated privileges, so it’s recommended to run Robosync as an Administrator. On Windows 11 (24H2 or later), you can prepend `sudo` to the command to run it with elevated permissions.\n\n### Building the Executable\n\nGenerate a standalone executable using Poetry’s build command:\n\n```powershell\npoetry build\n```\n\nThe resulting binary will be placed in the `dist/` directory.\n\n### Testing\n\nRun the test suite with `pytest`:\n\n```powershell\npoetry run pytest\n```\n\n### Code Quality\n\n- **Formatting**: Apply project styling with Black:\n\n  ```powershell\n  poetry run black .\n  ```\n\n- **Linting**: Enforce code standards using Flake8:\n\n  ```powershell\n  poetry run flake8 .\n  ```\n\n## License\n\nThis project is distributed under the MIT License. See the [LICENSE](LICENSE) file for full terms.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyounesaassila%2Frobosync","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyounesaassila%2Frobosync","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyounesaassila%2Frobosync/lists"}