{"id":18929954,"url":"https://github.com/redhatcre/syncron","last_synced_at":"2025-10-11T23:38:25.441Z","repository":{"id":59669939,"uuid":"535286781","full_name":"RedHatCRE/syncron","owner":"RedHatCRE","description":null,"archived":false,"fork":false,"pushed_at":"2023-12-18T22:47:40.000Z","size":177,"stargazers_count":2,"open_issues_count":6,"forks_count":2,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-15T17:15:57.023Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/RedHatCRE.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}},"created_at":"2022-09-11T12:09:23.000Z","updated_at":"2023-01-09T09:29:44.000Z","dependencies_parsed_at":"2024-06-21T09:55:51.012Z","dependency_job_id":"63836ad7-54d5-44f7-9bca-7a44c46d341a","html_url":"https://github.com/RedHatCRE/syncron","commit_stats":{"total_commits":66,"total_committers":8,"mean_commits":8.25,"dds":0.7121212121212122,"last_synced_commit":"58323e43332752fc516b49eebf90b67717fa3303"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/RedHatCRE/syncron","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedHatCRE%2Fsyncron","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedHatCRE%2Fsyncron/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedHatCRE%2Fsyncron/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedHatCRE%2Fsyncron/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RedHatCRE","download_url":"https://codeload.github.com/RedHatCRE/syncron/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RedHatCRE%2Fsyncron/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279009392,"owners_count":26084580,"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-10-11T02:00:06.511Z","response_time":55,"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":[],"created_at":"2024-11-08T11:35:57.679Z","updated_at":"2025-10-11T23:38:25.409Z","avatar_url":"https://github.com/RedHatCRE.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n  \u003cimg alt=\"cgapp logo\" src=\"https://i.imgur.com/QdUJPDU.png\" width=\"100px\"/\u003e\n\n# Syncron\n\nUsage Patterns all in one cli based application written in Golang.\n\n[![GoProject](https://img.shields.io/badge/Go-1.18+-00ADD8?style=for-the-badge\u0026logo=go)](https://github.com/RedHatCRE/syncron) [![GoReport](https://img.shields.io/badge/Go_report-A+-success?style=for-the-badge\u0026logo=none)](https://goreportcard.com/badge/github.com/redhatcre/syncron) ![License](https://img.shields.io/badge/license-apache_2.0-red?style=for-the-badge\u0026logo=none)\n\u003c/div\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://i.imgur.com/AtTFOVi.png\"\u003e\n\u003c/p\u003e\n\n## 🔧 Installation\n\n\n- [Download](https://golang.org/dl/) and install **Go**. \n    \u003e Follow the link for instructions\n    \u003e 🔔 Please note: version 1.18 or higher required\n- Clone this repository.\n    \n    \u003e `git clone git@github.com:RedHatCRE/syncron.git`\n\n- Navigate to local cloned repository folder and install Syncron with:\n    \n    \u003e `go install`\n\n- Check that Syncron has been properly installed on your environment by running\n    \u003e `syncron -v`\n    \u003e `syncron version 1.0.0`\n\n    - Make sure your gopath is added to your path\n      \u003e  `export PATH=$PATH:$(go env GOPATH)/bin`\n\n\n\n## 📖 Setup\n\nTo use Syncron, two important steps must be taken.\n\n- Create **configuration file**. \n    - Important information about config:\n        - Yaml based\n        - Path: ~/.config/\n        - Naming: syncron.yaml\n        - A minimal syncron configuration file is as follows:\n\n            ```yaml\n            s3:\n              endpoint: \"\u003cendpoint\u003e\"\n              region: \"\u003cregion\u003e\"\n              bucket: \"\u003cname of bucket to pull from\u003e\"\n            prefix: \"\u003ctargeted keys starting path\u003e\"\n            downloadDir: \"\u003cpath where files will be downloaded\u003e\"\n            ```\n\n- For downloading files from a AWS buckets, proper credentials must be present on running machine. Two options:\n  - Credentials file at $HOME/.aws/credentials\n    - The credentials file has the following format:\n    \n      ```\n      [default]\n      aws_access_key_id = \"XXXXXXX\"\n      aws_secret_access_key = \"XXXXXXX\"\n      ```\n      \n  - Environment variables must be set:\n    - export AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE\n    - export AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\n\n\n## ⚙️ Commands \u0026 Options\n\n\nThe user is given several flags to pick which time frame to pull data from.\n\n\n\u003e ##### **Download files**\n\n| Option | Description                                              | Type   | Required? |\n|--------|----------------------------------------------------------|--------|-----------|\n| `download`   | Download files.| `string` | No        |\n\n```bash\nsyncron download [option] [--flag] [number]\n```\n\n| --flag | Description                                              | Type   | Default | Required? |\n|--------|----------------------------------------------------------|--------|---------|-----------|\n| `days`   | Download files from the past x days. | `int` | `2` | No        |\n| `months`   | Download files from the past x months. | `int` | `0` | No        |\n| `years`   | Download files from the past x years. | `int` | `0` | No        |\n| `filter`   | Filter files to download | `[]str` | []str{} | No        |\n\n| Option | Description                                              | Type   | Default | Required? |\n|--------|----------------------------------------------------------|--------|---------|-----------|\n| `sosreports`   | Download sosreports files.| `string` | `sosreports` | Yes        |\n\n\u003e ##### **Read parquet files**\n\n```bash\nsyncron read-parquet [--flag] [option]\n```\n\n| Option | Description                                              | Type   | Required? |\n|--------|----------------------------------------------------------|--------|-----------|\n| `read-parquet`   | Read local parquet files.| `string` | No        |\n\n| --flag | Description                                              | Type   | Default | Required? |\n|--------|----------------------------------------------------------|--------|---------|-----------|\n| `file`   | What file to read. | `str` | `-` | Yes        |\n| `output`   | Path to place unpacked file. | `str` |  | Yes        |\n\n\u003e ##### **Query data from database**\n\n```bash\nsyncron queries\n```\n\n## ⚠️ License\n\n`Syncron` is free and open-source software licensed under the [Apache 2.0 License](https://github.com/RedHatCRE/syncron/blob/main/LICENSE). \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhatcre%2Fsyncron","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fredhatcre%2Fsyncron","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fredhatcre%2Fsyncron/lists"}