{"id":25984983,"url":"https://github.com/jjcfrancisco/yeo","last_synced_at":"2026-05-07T13:37:31.471Z","repository":{"id":229955019,"uuid":"777628936","full_name":"jjcfrancisco/yeo","owner":"jjcfrancisco","description":"Yeo! is a tiny backup utility for PostgreSQL databases.","archived":false,"fork":false,"pushed_at":"2024-04-04T07:05:56.000Z","size":303,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-23T04:43:23.028Z","etag":null,"topics":["database","go","postgresql"],"latest_commit_sha":null,"homepage":"https://pkg.go.dev/github.com/jjcfrancisco/yeo","language":"Go","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/jjcfrancisco.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":"2024-03-26T08:06:43.000Z","updated_at":"2024-09-06T08:33:51.000Z","dependencies_parsed_at":"2024-03-27T04:52:00.689Z","dependency_job_id":"c69b65e6-534b-47a9-8b48-2c6e3f45bc32","html_url":"https://github.com/jjcfrancisco/yeo","commit_stats":null,"previous_names":["jjcfrancisco/yeo"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/jjcfrancisco/yeo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjcfrancisco%2Fyeo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjcfrancisco%2Fyeo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjcfrancisco%2Fyeo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjcfrancisco%2Fyeo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jjcfrancisco","download_url":"https://codeload.github.com/jjcfrancisco/yeo/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jjcfrancisco%2Fyeo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32740594,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-07T02:14:30.463Z","status":"ssl_error","status_checked_at":"2026-05-07T02:14:29.405Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["database","go","postgresql"],"created_at":"2025-03-05T11:52:46.057Z","updated_at":"2026-05-07T13:37:31.446Z","avatar_url":"https://github.com/jjcfrancisco.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Yeo!\nYeo! is a tiny backup utility for PostgreSQL databases. The intention with Yeo! is not to substitute utilities such as `pg_dump` or `pg_restore` but to speed up trivial Postgres operations related to backing up and restoring databases.\n\n\u003cbr\u003e\n\n\u003cimg src=\"examples/clone-demo.gif\" width=\"350\"/\u003e\n\n## Features\n\n With `yeo` you can:\n* Back up a database using the `backup` command - known in Postgres terminology as **dump**. For more [here](https://www.postgresql.org/docs/current/app-pgdump.html).\n* Revive a database using the `revive` command - known in Postgres terminology as **restore**. For more [here](https://www.postgresql.org/docs/current/app-pgrestore.html).\n* Clone a database using the `clone` command - a combination of dump and restore in the Postgres terminology.\n\n## Installation\n\u003e **Yeo! is currently only available for MacOS and Linux users via [Homebrew](https://brew.sh/)**\n\n\nTo install `yeo`:\n\n```bash\n# Installing libpq is essential\nbrew install libpq # Make sure libpq is in your PATH\nbrew tap jjcfrancisco/yeo # Adds the Github repository as a tap\nbrew install yeo\n```\n\nAlternatively, you can use the already-built binaries for MacOS [here](https://github.com/jjcfrancisco/yeo/releases/).\n\n## Requirements\nThe only thing you need after the installation process is a `databases.json` file with credentials of databases. It must be populated with credentials of at least one database.\n\n**IMPORTANT**: Yeo! will look for the `databases.json` in your user's home directory e.g. `/Users/joebloggs/databases.json`.\n\nThe `databases.json` must follow this JSON structure:\n```json\n{\n    \"databases\": [\n        {\n            \"name\": \"local\",\n            \"isLocal\": true,\n            \"database\": \"my_local_db\",\n            \"port\": \"5432\",\n            \"host\": \"localhost\",\n            \"user\": \"yeo\",\n            \"password\": \"mysecretpassword\"\n        },\n        {\n            \"name\": \"development\",\n            \"isLocal\": false,\n            \"database\": \"dev\",\n            \"port\": \"5432\",\n            \"host\": \"yeo.host.com\",\n            \"user\": \"yeo\",\n            \"password\": \"mysecretpassword\"\n        }\n    ]\n}\n```\n\n## Usage\nTo back up a database:\n```bash\n# 'local' is the name set in the databases.json and can be personalised\n\nyeo backup local db_backup.dump\n```\n\nTo revive a database from a backup file:\n```bash\n# 'local' or 'prod' are names set in the database.json and can be personalised. The '--allow' flag allows to revive into non-local databases. \n\nyeo revive db_backup.dump local\nyeo revive --allow db_backup.dump prod\n```\n\nTo clone a database (backup + revive):\n```bash\n# 'local1', 'local2' or 'prod' are names set in the database.json and can be personalised. The '--allow' flag allows to revive into non-local databases.\n\nyeo clone local1 local2\nyeo clone --allow local1 prod\n```\n\n## Future improvements\n* Validation for `databases.json` against schema.\n* It should not be 'isLocal' but 'lock' for consistency reasons.\n\n## License\n\nSee [`LICENSE`](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjjcfrancisco%2Fyeo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjjcfrancisco%2Fyeo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjjcfrancisco%2Fyeo/lists"}